---
title: "Create Connector Instance"
method: POST
path: "/api/v1/connector-instances"
tags: ["Connector Instances"]
---

# Create Connector Instance

`POST /api/v1/connector-instances`

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 | | |

## Request body

- ConnectorInstancesStoreRequest
  - `authentication_implementation_template_id` string, required
  - `timezone` string, required
  - `date_format` string, required
  - `rate_limit_unit` 'second' | 'minute' | 'hour' | 'day', required
  - `rate_limit_duration` integer, required
  - `connection_pool_id` integer, nullable
  - `variable_templates` string, nullable, required
  - `name` string, required

## Response `200`

Successful response

- ConnectorInstancesResponse
  - `data` ConnectorInstances
    - `id` integer — Unique identifier
    - `authentication_implementation_template_id` string
    - `timezone` string
    - `date_format` string
    - `rate_limit_unit` 'second' | 'minute' | 'hour' | 'day'
    - `rate_limit_duration` integer
    - `connection_pool_id` integer
    - `variable_templates` string
    - `created_at` string, date-time
    - `updated_at` string, date-time

## Other responses

- `401` — Unauthenticated
- `403` — Unauthorized
- `422` — Validation Error

---

[API](https://skmtc.net/wearepatchworks/apis/patchworks-core-api.md) · [All operations](https://skmtc.net/wearepatchworks/apis/patchworks-core-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wearepatchworks/patchworks-core-api/revisions/89261af4dd80/schema)