OpenApiConnectorCreateRequest

Creates a connector to one HTTP endpoint.

Kind: an object, used in requests.

Fields

Field	Type	Required	Description
httpMethod	HttpMethod	yes	The HTTP method. Constraints: required (empty or whitespace-only strings are rejected).
pathParameters	OpenApiParameterInput[]	yes	The parameters in the URL’s path, one for each {name} in url ([] for none). Constraints: required (empty or whitespace-only strings are rejected).
queryParameters	OpenApiParameterInput[]	yes	The query-string parameters ([] for none). Constraints: required (empty or whitespace-only strings are rejected).
name	string	yes	The connector’s name, unique within its namespace (under 150 characters). Constraints: maxLength: 150, required (empty or whitespace-only strings are rejected).
url	string	yes	The endpoint’s URL. For an HTTP connector, {name} in it marks a path parameter; for an MCP connector, it is the MCP server’s URL. Constraints: format: url, required (empty or whitespace-only strings are rejected).
description	string	yes	What the endpoint does, in a sentence (under 500 characters). Constraints: maxLength: 500, required (empty or whitespace-only strings are rejected).
requestSchemaJson	string | null		The JSON Schema of the request body, as text. The model’s arguments are checked against it before a call is made. Omitted: no body is sent.
responseSchemaJson	string | null		The JSON Schema the endpoint’s response must match, as text. Omitted: the response is not checked.
authenticationType	ConnectorAuthenticationType	yes	The kind of credential the endpoint needs. The credential itself is given where a tool uses the connector. Constraints: required (empty or whitespace-only strings are rejected).
postProcessResponseUnicodeCharacters	boolean		Whether to replace typographic characters in the response (curly quotes, dashes, bullets, the ellipsis) with plain ones before it is read. Defaults to false.

Example

{
  "httpMethod": {
    "method": "..."
  },
  "pathParameters": [
    {
      "description": "...",
      "name": "...",
      "dataType": "String",
      "isRequired": false
    }
  ],
  "queryParameters": [
    {
      "description": "...",
      "name": "...",
      "dataType": "String",
      "isRequired": false
    }
  ],
  "name": "...",
  "url": "...",
  "description": "...",
  "requestSchemaJson": "...",
  "responseSchemaJson": "...",
  "authenticationType": "None",
  "postProcessResponseUnicodeCharacters": false
}

Where it’s used

• connectors.createOpenApi (POST /namespaces/{namespaceName}/connectors/open-api)