Sign in

v4

latestOpenAPI 3.1.1Apache 2.02026-07-31107278570.4 KB
Connectors

Create a custom provider

Creates an environment-scoped custom provider (connector) with authentication patterns and optional proxy configuration. The returned identifier must be used for all subsequent update and delete operations on this provider.

post/api/v1/custom-providers

Request body

auth_patternsobject[]

Authentication patterns for the connected app provider

descriptionstring

Description of the connected app provider

display_namestring

Display name for the connected app provider

icon_srcstring

URL for the provider icon. Should be an SVG image sized 800x800 pixels for best rendering experience.

metadataobject

Custom key-value metadata for this provider. Keys must be 3-25 characters, values must be 1-256 characters, with a maximum of 20 key-value pairs.

proxy_enabledboolean

This flag indicates whether proxying is turned on for the connected app provider. When enabled, requests are routed through the provider proxy instead of being sent directly.

proxy_urlstring

Proxy URL for the connected app provider. Must start with https://

Example request

{
  "description": "Connect to Google Workspace for email and calendar integration",
  "display_name": "Google Workspace",
  "icon_src": "https://example.com/images/my-connector.svg",
  "metadata": {
    "api_version": "v2",
    "region": "us-east-1"
  },
  "proxy_enabled": true,
  "proxy_url": "https://mcp.example.com/mcp"
}

Response

Returns the newly created custom provider, including its system-generated identifier and configuration

Example response

{
  "provider": {
    "metadata": {
      "api_version": "v2",
      "region": "us-east-1"
    }
  }
}