Skip to main content
POST
Create a connector

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Query Parameters

expand
string | null

Comma-separated fields to resolve on the created connector, with the same tokens as the get endpoint: actions, versions, changelog, accounts_count, connector_profiles_count. Unexpanded fields are null.

Body

application/json

Exactly one of the two source-specific shapes: create from a remote MCP server url, or register a StackOne connector YAML definition.

mcp_server_url
string<uri>
required

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). The connector is created without actions; its tools are added separately.

Pattern: ^https?://
title
string

The display name of the connector; it also derives the connector key. Defaults to the name the MCP server reports about itself, or to the server URL hostname.

Minimum string length: 1
force
enum<boolean>

Not supported when creating from an MCP server url; accepted only as false, which is a no-op.

Available options:
false

Response

The connector was created.

key
string
required

The connector key (e.g. workday).

name
string
required

The human-readable connector name (e.g. Workday).

logo_url
string
required

The URL of the connector's logo.

description
string | null
required

The connector description; null when the connector declares none.

categories
string[]
required

The categories the connector belongs to (e.g. ["hris"]).

authentication_methods
object[]
required

One-line summaries of the authentication methods the connector supports.

version
string
required

The connector version.

owner
string
required

The owner of the connector.

release_stage
string
required

The release stage of the connector (e.g. ga, beta).

actions_count
integer
required

The number of actions the connector exposes to the organization; 0 when the connector does not report action counts.

events_count
integer
required

The number of event actions the connector exposes; 0 when the connector does not report event counts.

documentation_url
string | null
required

The URL of the public StackOne documentation for the connector; null when no public documentation is available.

authentication
object
required

The authentication methods the connector supports, keyed by authentication config key and then by environment. Contains field definitions, notices and OAuth metadata — never credential values.

actions
object[] | null
required

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.

enabled_actions_count
integer | null
required

How many of the connector's actions the connector profile given in connector_profile_id enables, out of actions_count. Only resolved when connector_profile_id is supplied together with expand=actions; null otherwise.

event_actions
object[] | null
required

The metadata of the event actions the connector exposes. Only resolved when expand=actions is requested; null otherwise.

versions
object[] | null
required

The registry versions of the connector, newest first — the version options a connector profile can be pinned to. Only resolved when expand=versions is requested; null otherwise. Empty for connectors with no registry versions.

changelog
object | null
required

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.

accounts_count
integer | null

The number of accounts linked to the connector in this project. Only resolved when expand=accounts_count is requested; null otherwise.

connector_profiles_count
integer | null

The number of connector profiles configured for the connector in this project. Only resolved when expand=connector_profiles_count is requested; null otherwise.