curl --request POST \
--url https://api.stackone.com/v2/connectors \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"mcp_server_url": "<string>",
"title": "<string>",
"custom_headers": [
"X-API-Key",
{
"name": "MCP-Profile",
"fixed": true
}
],
"force": false
}
'import requests
url = "https://api.stackone.com/v2/connectors"
payload = {
"mcp_server_url": "<string>",
"title": "<string>",
"custom_headers": [
"X-API-Key",
{
"name": "MCP-Profile",
"fixed": True
}
],
"force": False
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
mcp_server_url: '<string>',
title: '<string>',
custom_headers: ['X-API-Key', {name: 'MCP-Profile', fixed: true}],
force: false
})
};
fetch('https://api.stackone.com/v2/connectors', 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.stackone.com/v2/connectors",
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([
'mcp_server_url' => '<string>',
'title' => '<string>',
'custom_headers' => [
'X-API-Key',
[
'name' => 'MCP-Profile',
'fixed' => true
]
],
'force' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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.stackone.com/v2/connectors"
payload := strings.NewReader("{\n \"mcp_server_url\": \"<string>\",\n \"title\": \"<string>\",\n \"custom_headers\": [\n \"X-API-Key\",\n {\n \"name\": \"MCP-Profile\",\n \"fixed\": true\n }\n ],\n \"force\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.stackone.com/v2/connectors")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"mcp_server_url\": \"<string>\",\n \"title\": \"<string>\",\n \"custom_headers\": [\n \"X-API-Key\",\n {\n \"name\": \"MCP-Profile\",\n \"fixed\": true\n }\n ],\n \"force\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stackone.com/v2/connectors")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"mcp_server_url\": \"<string>\",\n \"title\": \"<string>\",\n \"custom_headers\": [\n \"X-API-Key\",\n {\n \"name\": \"MCP-Profile\",\n \"fixed\": true\n }\n ],\n \"force\": false\n}"
response = http.request(request)
puts response.read_body{
"key": "<string>",
"name": "<string>",
"logo_url": "<string>",
"description": "<string>",
"categories": [
"<string>"
],
"authentication_methods": [
{
"key": "<string>",
"label": "<string>",
"type": "<string>"
}
],
"version": "<string>",
"owner": "<string>",
"release_stage": "<string>",
"actions_count": 123,
"events_count": 123,
"documentation_url": "<string>",
"authentication": {},
"actions": [
{
"id": "<string>",
"label": "<string>",
"description": "<string>",
"schema_type": "<string>",
"authentication": [
{
"type": "<string>",
"label": "<string>",
"key": "<string>",
"required_scopes": [
"<string>"
],
"description": "<string>"
}
],
"tags": [
"<string>"
],
"required_scopes": [
"<string>"
],
"release_stage": "<string>",
"effects": [
"<string>"
],
"annotations": {
"title": "<string>",
"readOnlyHint": true,
"destructiveHint": true,
"idempotentHint": true,
"openWorldHint": true
},
"action_details": {},
"syncable": true,
"supports_incremental": true,
"has_required_parameters": true,
"lookback_default_window": "<string>",
"supports_verify_deletions": true,
"enabled": true
}
],
"enabled_actions_count": 123,
"event_actions": [
{
"id": "<string>",
"label": "<string>",
"description": "<string>",
"tags": [
"<string>"
],
"release_stage": "<string>",
"requires_manual_setup": true,
"authentication": [
{
"type": "<string>",
"label": "<string>",
"key": "<string>",
"required_scopes": [
"<string>"
],
"description": "<string>"
}
]
}
],
"scope_definitions": [
{
"name": "<string>",
"description": "<string>",
"includes": [
"<string>"
]
}
],
"versions": [
{
"version": "<string>",
"owner": "<string>",
"builtin": true,
"release_stage": "<string>"
}
],
"changelog": {
"current_version": "<string>",
"entries": [
{
"version": "<string>",
"summary": "<string>",
"labels": [
"<string>"
],
"released_at": "2023-11-07T05:31:56Z",
"affected_actions": {
"added": [
"<string>"
],
"removed": [
"<string>"
],
"changed": [
"<string>"
]
}
}
]
},
"accounts_count": 123,
"connector_profiles_count": 123
}{
"statusCode": 400,
"message": "Bad Request",
"timestamp": "2023-05-30T00:00:00.000Z",
"data": {
"statusCode": 400,
"message": "Bad Request",
"headers": {
"content-type": "application/json",
"x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}
},
"provider_errors": [
{
"status": 400,
"url": "https://api.provider.com/v1/resource",
"raw": {
"message": "Invalid input parameters"
},
"headers": {
"content-type": "application/json",
"x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}
}
]
}{
"statusCode": 401,
"message": "Unauthorized",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 403,
"message": "Forbidden resource",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 404,
"message": "Not Found",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 408,
"message": "Request timed out",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 409,
"message": "Conflict",
"timestamp": "2023-05-30T00:00:00.000Z",
"latest_version": "1.2.0"
}{
"statusCode": 422,
"message": "Unprocessable Entity",
"timestamp": "2023-05-30T00:00:00.000Z",
"latest_version": "1.2.0"
}{
"statusCode": 429,
"message": "Too many requests",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 500,
"message": "Internal server error",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 501,
"message": "Not Implemented",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 502,
"message": "Bad Gateway",
"timestamp": "2023-05-30T00:00:00.000Z"
}Create a connector
Creates a custom connector in the current project’s registry. It is owned by this project and is not available to the organization’s other projects. A YAML connector with a new connector key takes one of the custom connector slots the organization’s plan includes. When every slot is in use the request is refused with 403 custom_connector_slot_limit_reached. New versions of an existing connector key and remote MCP connectors take no new slot. A YAML connector whose version already exists is refused with 409, and one whose version is not greater than the project’s latest with 422; both carry that latest version as latest_version.
curl --request POST \
--url https://api.stackone.com/v2/connectors \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"mcp_server_url": "<string>",
"title": "<string>",
"custom_headers": [
"X-API-Key",
{
"name": "MCP-Profile",
"fixed": true
}
],
"force": false
}
'import requests
url = "https://api.stackone.com/v2/connectors"
payload = {
"mcp_server_url": "<string>",
"title": "<string>",
"custom_headers": [
"X-API-Key",
{
"name": "MCP-Profile",
"fixed": True
}
],
"force": False
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
mcp_server_url: '<string>',
title: '<string>',
custom_headers: ['X-API-Key', {name: 'MCP-Profile', fixed: true}],
force: false
})
};
fetch('https://api.stackone.com/v2/connectors', 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.stackone.com/v2/connectors",
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([
'mcp_server_url' => '<string>',
'title' => '<string>',
'custom_headers' => [
'X-API-Key',
[
'name' => 'MCP-Profile',
'fixed' => true
]
],
'force' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"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.stackone.com/v2/connectors"
payload := strings.NewReader("{\n \"mcp_server_url\": \"<string>\",\n \"title\": \"<string>\",\n \"custom_headers\": [\n \"X-API-Key\",\n {\n \"name\": \"MCP-Profile\",\n \"fixed\": true\n }\n ],\n \"force\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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.stackone.com/v2/connectors")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"mcp_server_url\": \"<string>\",\n \"title\": \"<string>\",\n \"custom_headers\": [\n \"X-API-Key\",\n {\n \"name\": \"MCP-Profile\",\n \"fixed\": true\n }\n ],\n \"force\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stackone.com/v2/connectors")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"mcp_server_url\": \"<string>\",\n \"title\": \"<string>\",\n \"custom_headers\": [\n \"X-API-Key\",\n {\n \"name\": \"MCP-Profile\",\n \"fixed\": true\n }\n ],\n \"force\": false\n}"
response = http.request(request)
puts response.read_body{
"key": "<string>",
"name": "<string>",
"logo_url": "<string>",
"description": "<string>",
"categories": [
"<string>"
],
"authentication_methods": [
{
"key": "<string>",
"label": "<string>",
"type": "<string>"
}
],
"version": "<string>",
"owner": "<string>",
"release_stage": "<string>",
"actions_count": 123,
"events_count": 123,
"documentation_url": "<string>",
"authentication": {},
"actions": [
{
"id": "<string>",
"label": "<string>",
"description": "<string>",
"schema_type": "<string>",
"authentication": [
{
"type": "<string>",
"label": "<string>",
"key": "<string>",
"required_scopes": [
"<string>"
],
"description": "<string>"
}
],
"tags": [
"<string>"
],
"required_scopes": [
"<string>"
],
"release_stage": "<string>",
"effects": [
"<string>"
],
"annotations": {
"title": "<string>",
"readOnlyHint": true,
"destructiveHint": true,
"idempotentHint": true,
"openWorldHint": true
},
"action_details": {},
"syncable": true,
"supports_incremental": true,
"has_required_parameters": true,
"lookback_default_window": "<string>",
"supports_verify_deletions": true,
"enabled": true
}
],
"enabled_actions_count": 123,
"event_actions": [
{
"id": "<string>",
"label": "<string>",
"description": "<string>",
"tags": [
"<string>"
],
"release_stage": "<string>",
"requires_manual_setup": true,
"authentication": [
{
"type": "<string>",
"label": "<string>",
"key": "<string>",
"required_scopes": [
"<string>"
],
"description": "<string>"
}
]
}
],
"scope_definitions": [
{
"name": "<string>",
"description": "<string>",
"includes": [
"<string>"
]
}
],
"versions": [
{
"version": "<string>",
"owner": "<string>",
"builtin": true,
"release_stage": "<string>"
}
],
"changelog": {
"current_version": "<string>",
"entries": [
{
"version": "<string>",
"summary": "<string>",
"labels": [
"<string>"
],
"released_at": "2023-11-07T05:31:56Z",
"affected_actions": {
"added": [
"<string>"
],
"removed": [
"<string>"
],
"changed": [
"<string>"
]
}
}
]
},
"accounts_count": 123,
"connector_profiles_count": 123
}{
"statusCode": 400,
"message": "Bad Request",
"timestamp": "2023-05-30T00:00:00.000Z",
"data": {
"statusCode": 400,
"message": "Bad Request",
"headers": {
"content-type": "application/json",
"x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}
},
"provider_errors": [
{
"status": 400,
"url": "https://api.provider.com/v1/resource",
"raw": {
"message": "Invalid input parameters"
},
"headers": {
"content-type": "application/json",
"x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}
}
]
}{
"statusCode": 401,
"message": "Unauthorized",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 403,
"message": "Forbidden resource",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 404,
"message": "Not Found",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 408,
"message": "Request timed out",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 409,
"message": "Conflict",
"timestamp": "2023-05-30T00:00:00.000Z",
"latest_version": "1.2.0"
}{
"statusCode": 422,
"message": "Unprocessable Entity",
"timestamp": "2023-05-30T00:00:00.000Z",
"latest_version": "1.2.0"
}{
"statusCode": 429,
"message": "Too many requests",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 500,
"message": "Internal server error",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 501,
"message": "Not Implemented",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 502,
"message": "Bad Gateway",
"timestamp": "2023-05-30T00:00:00.000Z"
}Authorizations
Query Parameters
Body
Exactly one of the two source-specific shapes: create from a remote MCP server url, or register a StackOne connector YAML definition.
- CreateMcpConnectorRequest
- CreateYamlConnectorRequest
The URL of the remote MCP server to create the connector for. The server is probed to determine how it authenticates (openly, with a static access token, or through OAuth); a server without OAuth authenticates with custom_headers instead when they are given. The connector is created without actions; its tools are added separately. A project holds one connector per server URL, compared with its query included.
^https?://The headers the MCP server expects on every request, such as an API key header. Each becomes a required secret field when an account is linked, so every account sends its own values, and the server authenticates with these headers instead of a bearer access token. A header given as { "name": "...", "fixed": true } is instead a required secret setup field of the connector profile, whose value is the default for every account. Rejected for a server with OAuth, and so are header names set by the MCP transport (such as Host or Mcp-Session-Id). Only valid with mcp_server_url.
101[
"X-API-Key",
{ "name": "MCP-Profile", "fixed": true }
]
Response
The connector was created.
The metadata of the actions the connector exposes (id, label, description, tags, required scopes…). Only resolved when expand=actions is requested; null otherwise. When connector_profile_id is supplied, the actions that profile enables come first and every action carries enabled.
Show child attributes
Show child attributes
The connector's release history: one entry per published version, newest first, with its summary, labels, release date and affected actions. Only resolved when expand=changelog is requested, and only for StackOne's built-in Falcon connectors; null otherwise, including connectors with no published changelog.
Show child attributes
Show child attributes
Was this page helpful?