latestOpenAPI 3.0.02026-08-107797148.2 KB

89261af4dd80

Activity Logs1

Agents1

AI1

Alerts1

Allowances1

Authentication Implementations1

Authentication Types1

Blueprints1

Cache Step1

Caches1

Canvas Notes1

Canvas Positions1

Canvas Step Connections1

Canvas Steps1

Certificates1

Company1

Connection Pools1

Connector Instances1

postCreate Connector Instance

Connectors1

Cross Reference Lookup Templates1

Cross Reference Lookups1

Data Pools1

Endpoint Templates1

Endpoints1

Entity Types1

Features1

Field Tags1

Filters1

Flow Callbacks1

Flow Folders1

Flow Metric Model Totals1

Flow Metric Value Summaries1

Flow Metric Value Totals1

Flow Routes & Branches1

Flow Run Logs1

Flow Templates1

Flow Version Deployments1

Flow Version Steps1

Flow Version Variables1

Flow Versions1

Flow Webhooks1

Flows1

General1

Job Execution Logs1

Label Templates1

Labels1

Mapping1

Marketplace Apps1

MCP Servers1

Media Files1

Message Broker Queues1

Message Brokers1

Model Filter Values1

Model Notes1

Model Variables1

Multi-Company Profiles1

Notifications1

Oauth1

Operations1

OTC1

Packages1

Payload Metadata1

Request Options1

Scheduled Flows1

Script Languages1

Script Templates1

Script Version Metrics1

Script Versions1

Scripts1

System Templates1

System Types1

Systems1

Tracked Data1

Transforms1

Variables1

Virtual Environment Versions1

Virtual Environments1

Connector Instances

Create Connector Instance

To be confirmed.

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field	Type	Required
name	string	☑
authentication_implementation_template_id		☑
timezone	string	☑
date_format	string	☑
rate_limit_unit	string	☑
rate_limit_duration	integer	☑
connection_pool_id	integer
variable_templates
variable_templates.*.key	string	☑
variable_templates.*.value	string
variable_templates.*.label	string	☑
variable_templates.*.secret
variable_templates.*.locked
variable_templates.*.pivot.alias	string
variable_templates.*.pivot.configurable
variable_templates.*.pivot.required
variable_templates.*.pivot.advanced

post/api/v1/connector-instances

Request body

authentication_implementation_template_idstring required

timezonestring required

date_formatstring required

rate_limit_unit'second' | 'minute' | 'hour' | 'day' required

rate_limit_durationinteger required

connection_pool_idinteger nullable

variable_templatesstring nullable required

namestring required

Response

Successful response