# Connectors ## List Connectors > Retrieves a paginated list of connectors. Can be filtered by \`canonical\_key\`, \`system\`, and other criteria. Note: In the Patchworks dashboard, a \`connector\` is known as an \`instance\`.\ > \ > \## Available Includes\ > \ > These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.\ > \ > \- authenticationImplementation\ > \- authenticationImplementation\_count\ > \- authenticationImplementationExists\ > \- authenticationImplementation.authenticationType\ > \- authenticationImplementation.system\ > \- authenticationImplementation.system.logo\ > \- authenticationImplementation.endpoints\ > \- authenticationImplementation.endpoints.filters\ > \- authenticationImplementation.endpoints.endpointSchema\ > \- authenticationImplementation.endpoints.system\ > \- authenticationImplementation.endpoints.system.logo\ > \- authenticationImplementation.endpoints.entityType\ > \- authenticationImplementation.endpoints.fieldTags\ > \- authenticationImplementation.system.systemType\ > \- variables\ > \- variables\_count\ > \- variablesExists\ > \- authenticationImplementation.endpoints.variables\ > \- certificate\ > \- certificate\_count\ > \- certificateExists\ > \- certificate.user\ > \ > \ > \## Available Filters\ > \ > These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.\ > \ > \- forSystemTemplate\ > \- forSession\ > \ > \ > \ > \ > \## Available Sorts\ > \ > These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.\ > \ > \- name ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Connectors"}],"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: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"ConnectorsListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Connectors"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"Connectors":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"authentication_implementation_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"},"variables":{"type":"string","items":{"type":"object"}},"session_id":{"type":"string"},"platform_app_key":{"type":"string"},"certificate_id":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"},"authentication_implementation":{"type":"array","items":{"type":"object"}},"system":{"type":"string"},"certificate":{"type":"string"}}},"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer"},"from":{"type":"integer","nullable":true},"last_page":{"type":"integer"},"path":{"type":"string"},"per_page":{"type":"integer"},"to":{"type":"integer","nullable":true},"total":{"type":"integer"}}},"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri"},"last":{"type":"string","format":"uri"},"prev":{"type":"string","format":"uri","nullable":true},"next":{"type":"string","format":"uri","nullable":true}}}}},"paths":{"/api/v1/connectors":{"get":{"summary":"List Connectors","description":"Retrieves a paginated list of connectors. Can be filtered by `canonical_key`, `system`, and other criteria. Note: In the Patchworks dashboard, a `connector` is known as an `instance`.\n\n## Available Includes\n\nThese are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.\n\n- authenticationImplementation\n- authenticationImplementation_count\n- authenticationImplementationExists\n- authenticationImplementation.authenticationType\n- authenticationImplementation.system\n- authenticationImplementation.system.logo\n- authenticationImplementation.endpoints\n- authenticationImplementation.endpoints.filters\n- authenticationImplementation.endpoints.endpointSchema\n- authenticationImplementation.endpoints.system\n- authenticationImplementation.endpoints.system.logo\n- authenticationImplementation.endpoints.entityType\n- authenticationImplementation.endpoints.fieldTags\n- authenticationImplementation.system.systemType\n- variables\n- variables_count\n- variablesExists\n- authenticationImplementation.endpoints.variables\n- certificate\n- certificate_count\n- certificateExists\n- certificate.user\n\n\n## Available Filters\n\nThese are the filters that can be used to specific the data to return. Please see the section on using filters for more details.\n\n- forSystemTemplate\n- forSession\n\n\n\n\n## Available Sorts\n\nThese are the sorts that can be used order the returned data. Please see the section on using sorting for more details.\n\n- name","parameters":[{"name":"filter[canonical_key]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by canonical_key."},{"name":"filter[forSystemTemplate]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by forSystemTemplate."},{"name":"filter[system]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by system."},{"name":"filter[system_template_id]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by system_template_id."},{"name":"filter[forSession]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by forSession."},{"name":"filter[platformSession]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by platformSession."},{"name":"include","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of relationships to include. Available: authenticationImplementation.authenticationType, authenticationImplementation.system, authenticationImplementation.system.logo, authenticationImplementation.endpoints, authenticationImplementation.endpoints.filters, authenticationImplementation.endpoints.endpointSchema, authenticationImplementation.endpoints.system, authenticationImplementation.endpoints.system.logo, authenticationImplementation.endpoints.entityType, authenticationImplementation.endpoints.fieldTags, authenticationImplementation.system.systemType, variables, authenticationImplementation.endpoints.variables, certificate.user"},{"name":"sort","in":"query","required":false,"schema":{"type":"string"},"description":"Sort field. Prefix with - for descending. Available: name"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1},"description":"Page number for pagination."},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100},"description":"Number of results per page."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorsListResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"}},"tags":["Connectors"]}}}} ``` ## Create Connector > Creates a new connector. Note: In the Patchworks dashboard, a \`connector\` is known as an \`instance\`.\ > \ > \## 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\_id | | \☑ |\ > \| timezone | string | \☑ |\ > \| date\_format | string | \☑ |\ > \| rate\_limit\_unit | string | \☑ |\ > \| rate\_limit\_duration | integer | \☑ |\ > \| connection\_pool\_id | integer | |\ > \| variables | | |\ > \| variables.\*.key | string | \☑ |\ > \| variables.\*.value | string | |\ > \| variables.\*.label | string | \☑ |\ > \| variables.\*.secret | | |\ > \| variables.\*.locked | | |\ > \| variables.\*.pivot.alias | string | |\ > \| variables.\*.pivot.configurable | | |\ > \| variables.\*.pivot.required | | |\ > \| variables.\*.pivot.advanced | | |\ > \| session\_id | string | |\ > \| platform\_app\_key | string | |\ > \| certificate\_id | string | | ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Connectors"}],"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: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"ConnectorsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Connectors"}}},"Connectors":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"authentication_implementation_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"},"variables":{"type":"string","items":{"type":"object"}},"session_id":{"type":"string"},"platform_app_key":{"type":"string"},"certificate_id":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"},"authentication_implementation":{"type":"array","items":{"type":"object"}},"system":{"type":"string"},"certificate":{"type":"string"}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"ConnectorsStoreRequest":{"type":"object","properties":{"authentication_implementation_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},"variables":{"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}}}}}}},"session_id":{"type":"string","nullable":true},"platform_app_key":{"type":"string"},"certificate_id":{"type":"string","nullable":true},"name":{"type":"string"}},"required":["authentication_implementation_id","date_format","name","rate_limit_duration","rate_limit_unit","timezone","variables"]}}},"paths":{"/api/v1/connectors":{"post":{"summary":"Create Connector","description":"Creates a new connector. Note: In the Patchworks dashboard, a `connector` is known as an `instance`.\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 | ☑ |\n| authentication_implementation_id | | ☑ |\n| timezone | string | ☑ |\n| date_format | string | ☑ |\n| rate_limit_unit | string | ☑ |\n| rate_limit_duration | integer | ☑ |\n| connection_pool_id | integer | |\n| variables | | |\n| variables.*.key | string | ☑ |\n| variables.*.value | string | |\n| variables.*.label | string | ☑ |\n| variables.*.secret | | |\n| variables.*.locked | | |\n| variables.*.pivot.alias | string | |\n| variables.*.pivot.configurable | | |\n| variables.*.pivot.required | | |\n| variables.*.pivot.advanced | | |\n| session_id | string | |\n| platform_app_key | string | |\n| certificate_id | string | |","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorsResponse"}}}},"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/ConnectorsStoreRequest"}}}},"tags":["Connectors"],"parameters":[]}}}} ``` ## Get Connector > Retrieves details for a given connector. Note: In the Patchworks dashboard, a \`connector\` is known as an \`instance\`.\ > \ > \## Available Includes\ > \ > These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.\ > \ > \- authenticationImplementation\ > \- authenticationImplementation\_count\ > \- authenticationImplementationExists\ > \- authenticationImplementation.authenticationType\ > \- authenticationImplementation.system\ > \- authenticationImplementation.system.logo\ > \- authenticationImplementation.endpoints\ > \- authenticationImplementation.endpoints.filters\ > \- authenticationImplementation.endpoints.endpointSchema\ > \- authenticationImplementation.endpoints.system\ > \- authenticationImplementation.endpoints.system.logo\ > \- authenticationImplementation.endpoints.entityType\ > \- authenticationImplementation.endpoints.fieldTags\ > \- authenticationImplementation.system.systemType\ > \- variables\ > \- variables\_count\ > \- variablesExists\ > \- authenticationImplementation.endpoints.variables\ > \- certificate\ > \- certificate\_count\ > \- certificateExists\ > \- certificate.user\ > \ > \ > \## Available Filters\ > \ > These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.\ > \ > \- forSystemTemplate\ > \- forSession\ > \ > \ > \ > \ > \## Available Sorts\ > \ > These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.\ > \ > \- name ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Connectors"}],"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: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"ConnectorsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Connectors"}}},"Connectors":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"authentication_implementation_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"},"variables":{"type":"string","items":{"type":"object"}},"session_id":{"type":"string"},"platform_app_key":{"type":"string"},"certificate_id":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"},"authentication_implementation":{"type":"array","items":{"type":"object"}},"system":{"type":"string"},"certificate":{"type":"string"}}}}},"paths":{"/api/v1/connectors/{connector}":{"get":{"summary":"Get Connector","description":"Retrieves details for a given connector. Note: In the Patchworks dashboard, a `connector` is known as an `instance`.\n\n## Available Includes\n\nThese are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.\n\n- authenticationImplementation\n- authenticationImplementation_count\n- authenticationImplementationExists\n- authenticationImplementation.authenticationType\n- authenticationImplementation.system\n- authenticationImplementation.system.logo\n- authenticationImplementation.endpoints\n- authenticationImplementation.endpoints.filters\n- authenticationImplementation.endpoints.endpointSchema\n- authenticationImplementation.endpoints.system\n- authenticationImplementation.endpoints.system.logo\n- authenticationImplementation.endpoints.entityType\n- authenticationImplementation.endpoints.fieldTags\n- authenticationImplementation.system.systemType\n- variables\n- variables_count\n- variablesExists\n- authenticationImplementation.endpoints.variables\n- certificate\n- certificate_count\n- certificateExists\n- certificate.user\n\n\n## Available Filters\n\nThese are the filters that can be used to specific the data to return. Please see the section on using filters for more details.\n\n- forSystemTemplate\n- forSession\n\n\n\n\n## Available Sorts\n\nThese are the sorts that can be used order the returned data. Please see the section on using sorting for more details.\n\n- name","parameters":[{"name":"connector","in":"path","required":true,"schema":{"type":"string"},"description":"The connector identifier."},{"name":"filter[canonical_key]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by canonical_key."},{"name":"filter[forSystemTemplate]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by forSystemTemplate."},{"name":"filter[system]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by system."},{"name":"filter[system_template_id]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by system_template_id."},{"name":"filter[forSession]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by forSession."},{"name":"filter[platformSession]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by platformSession."},{"name":"include","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of relationships to include. Available: authenticationImplementation.authenticationType, authenticationImplementation.system, authenticationImplementation.system.logo, authenticationImplementation.endpoints, authenticationImplementation.endpoints.filters, authenticationImplementation.endpoints.endpointSchema, authenticationImplementation.endpoints.system, authenticationImplementation.endpoints.system.logo, authenticationImplementation.endpoints.entityType, authenticationImplementation.endpoints.fieldTags, authenticationImplementation.system.systemType, variables, authenticationImplementation.endpoints.variables, certificate.user"},{"name":"sort","in":"query","required":false,"schema":{"type":"string"},"description":"Sort field. Prefix with - for descending. Available: name"},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1},"description":"Page number for pagination."},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"maximum":100},"description":"Number of results per page."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorsResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"}},"tags":["Connectors"]}}}} ``` ## Update Connector > Update an existing connector. Note: In the Patchworks dashboard, a \`connector\` is known as an \`instance\`.\ > \ > \## 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 |\ > \|---|---|---|\ > \| authentication\_implementation\_id | | |\ > \| name | string | |\ > \| type | string | |\ > \| timezone | string | |\ > \| date\_format | string | |\ > \| rate\_limit\_unit | string | |\ > \| rate\_limit\_duration | integer | |\ > \| connection\_pool\_id | integer | |\ > \| variables | | |\ > \| variables.\*.id | string | \☑ |\ > \| variables.\*.key | string | |\ > \| variables.\*.value | string | |\ > \| variables.\*.label | string | |\ > \| variables.\*.secret | | |\ > \| variables.\*.locked | | |\ > \| variables.\*.pivot.alias | string | |\ > \| variables.\*.pivot.configurable | | |\ > \| variables.\*.pivot.required | | |\ > \| variables.\*.pivot.advanced | | | ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Connectors"}],"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: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"ConnectorsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Connectors"}}},"Connectors":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"authentication_implementation_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"},"variables":{"type":"string","items":{"type":"object"}},"session_id":{"type":"string"},"platform_app_key":{"type":"string"},"certificate_id":{"type":"string"},"type":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"name":{"type":"string"},"authentication_implementation":{"type":"array","items":{"type":"object"}},"system":{"type":"string"},"certificate":{"type":"string"}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"ConnectorsUpdateRequest":{"type":"object","properties":{"authentication_implementation_id":{"type":"string"},"type":{"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},"variables":{"type":"string","properties":{"*":{"type":"object","properties":{"id":{"type":"string"},"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":["variables"]}}},"paths":{"/api/v1/connectors/{connector}":{"put":{"summary":"Update Connector","description":"Update an existing connector. Note: In the Patchworks dashboard, a `connector` is known as an `instance`.\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| authentication_implementation_id | | |\n| name | string | |\n| type | string | |\n| timezone | string | |\n| date_format | string | |\n| rate_limit_unit | string | |\n| rate_limit_duration | integer | |\n| connection_pool_id | integer | |\n| variables | | |\n| variables.*.id | string | ☑ |\n| variables.*.key | string | |\n| variables.*.value | string | |\n| variables.*.label | string | |\n| variables.*.secret | | |\n| variables.*.locked | | |\n| variables.*.pivot.alias | string | |\n| variables.*.pivot.configurable | | |\n| variables.*.pivot.required | | |\n| variables.*.pivot.advanced | | |","parameters":[{"name":"connector","in":"path","required":true,"schema":{"type":"string"},"description":"The connector identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectorsResponse"}}}},"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/ConnectorsUpdateRequest"}}}},"tags":["Connectors"]}}}} ``` ## Delete Connector > Delete an existing connector. Note: In the Patchworks dashboard, a \`connector\` is known as an \`instance\`. ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Connectors"}],"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: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"MessageResponse":{"type":"object","properties":{"message":{"type":"string"}}}}},"paths":{"/api/v1/connectors/{connector}":{"delete":{"summary":"Delete Connector","description":"Delete an existing connector. Note: In the Patchworks dashboard, a `connector` is known as an `instance`.","parameters":[{"name":"connector","in":"path","required":true,"schema":{"type":"string"},"description":"The connector identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"}},"tags":["Connectors"]}}}} ``` ## Test Connector > Test the connection to ensure authentication credentials are valid . Note: In the Patchworks dashboard, a \`connector\` is known as an \`instance\`. ```json {"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Connectors"}],"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: ``"},"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"OAuth 2 Bearer token obtained from POST /fabric/api/login"}},"schemas":{"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}}},"paths":{"/api/v1/connectors/{connector}/test":{"post":{"summary":"Test Connector","description":"Test the connection to ensure authentication credentials are valid . Note: In the Patchworks dashboard, a `connector` is known as an `instance`.","tags":["Connectors"],"parameters":[{"name":"connector","in":"path","required":true,"schema":{"type":"string"},"description":"The connector identifier."}],"responses":{"200":{"description":"Successful response"},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}}} ```