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

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Connector Instances"}],"servers":[{"url":"https://core.wearepatchworks.com"}],"security":[{"ApiKeyAuth":[]},{"BearerAuth":[]}],"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"Authorization","description":"API key passed in the Authorization header. Format: `<api-key>`"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"ConnectorInstancesResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ConnectorInstances"}}},"ConnectorInstances":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"authentication_implementation_template_id":{"type":"string"},"timezone":{"type":"string"},"date_format":{"type":"string"},"rate_limit_unit":{"type":"string","enum":["second","minute","hour","day"]},"rate_limit_duration":{"type":"integer"},"connection_pool_id":{"type":"integer"},"variable_templates":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"ConnectorInstancesStoreRequest":{"type":"object","properties":{"authentication_implementation_template_id":{"type":"string"},"timezone":{"type":"string"},"date_format":{"type":"string"},"rate_limit_unit":{"type":"string","enum":["second","minute","hour","day"]},"rate_limit_duration":{"type":"integer"},"connection_pool_id":{"type":"integer","nullable":true},"variable_templates":{"type":"string","nullable":true,"properties":{"*":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string","nullable":true},"label":{"type":"string"},"secret":{"type":"boolean","nullable":true},"locked":{"type":"boolean","nullable":true},"pivot":{"type":"object","properties":{"alias":{"type":"string","nullable":true},"configurable":{"type":"boolean","nullable":true},"required":{"type":"boolean","nullable":true},"advanced":{"type":"boolean","nullable":true}}}}}}},"name":{"type":"string"}},"required":["authentication_implementation_template_id","date_format","name","rate_limit_duration","rate_limit_unit","timezone","variable_templates"]}}},"paths":{"/api/v1/connector-instances":{"post":{"summary":"Create Connector Instance","description":"To be confirmed.\n\n## Validation Rules\n\nThese 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\n\n| Field | Type | Required |\n|---|---|---|\n| name | string | &#x2611; |\n| authentication_implementation_template_id | | &#x2611; |\n| timezone | string | &#x2611; |\n| date_format | string | &#x2611; |\n| rate_limit_unit | string | &#x2611; |\n| rate_limit_duration | integer | &#x2611; |\n| connection_pool_id | integer | |\n| variable_templates | | |\n| variable_templates.*.key | string | &#x2611; |\n| variable_templates.*.value | string | |\n| variable_templates.*.label | string | &#x2611; |\n| variable_templates.*.secret | | |\n| variable_templates.*.locked | | |\n| variable_templates.*.pivot.alias | string | |\n| variable_templates.*.pivot.configurable | | |\n| variable_templates.*.pivot.required | | |\n| variable_templates.*.pivot.advanced | | |","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorInstancesResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorInstancesStoreRequest"}}}},"tags":["Connector Instances"],"parameters":[]}}}}
```