# Connection Pools

## List Connection Pools

> Retrieves a paginated list of connection pools.

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Connection Pools"}],"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":{"ConnectionPoolsListResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ConnectionPools"}},"meta":{"$ref":"#/components/schemas/PaginationMeta"},"links":{"$ref":"#/components/schemas/PaginationLinks"}}},"ConnectionPools":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"limit":{"type":"integer"},"timeout":{"type":"integer","items":{"type":"object"}},"created_at":{"type":"string","format":"date-time","items":{"type":"object"}},"updated_at":{"type":"string","format":"date-time","items":{"type":"object"}},"name":{"type":"string"},"connectors":{"type":"array","items":{"type":"object"}}}},"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/connection-pools":{"get":{"summary":"List Connection Pools","description":"Retrieves a paginated list of connection pools.","parameters":[{"name":"filter[name]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by name."},{"name":"include","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of relationships to include. Available: connectors.system"},{"name":"sort","in":"query","required":false,"schema":{"type":"string"},"description":"Sort field. Prefix with - for descending. Available: name, limit, created_at"},{"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/ConnectionPoolsListResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"}},"tags":["Connection Pools"]}}}}
```

## Create Connection Pool

> Creates a new connection pool.

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Connection Pools"}],"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":{"ConnectionPoolsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ConnectionPools"}}},"ConnectionPools":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"limit":{"type":"integer"},"timeout":{"type":"integer","items":{"type":"object"}},"created_at":{"type":"string","format":"date-time","items":{"type":"object"}},"updated_at":{"type":"string","format":"date-time","items":{"type":"object"}},"name":{"type":"string"},"connectors":{"type":"array","items":{"type":"object"}}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"ConnectionPoolsStoreRequest":{"type":"object","properties":{"limit":{"type":"integer","minimum":1},"timeout":{"type":"integer","minimum":1,"nullable":true},"name":{"type":"string","maxLength":255}},"required":["limit","name"]}}},"paths":{"/api/v1/connection-pools":{"post":{"summary":"Create Connection Pool","description":"Creates a new connection pool.","responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionPoolsResponse"}}}},"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/ConnectionPoolsStoreRequest"}}}},"tags":["Connection Pools"],"parameters":[]}}}}
```

## Get Connection Pool

> Retrieves the details of a specific connection pool.

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Connection Pools"}],"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":{"ConnectionPoolsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ConnectionPools"}}},"ConnectionPools":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"limit":{"type":"integer"},"timeout":{"type":"integer","items":{"type":"object"}},"created_at":{"type":"string","format":"date-time","items":{"type":"object"}},"updated_at":{"type":"string","format":"date-time","items":{"type":"object"}},"name":{"type":"string"},"connectors":{"type":"array","items":{"type":"object"}}}}}},"paths":{"/api/v1/connection-pools/{connection_pool}":{"get":{"summary":"Get Connection Pool","description":"Retrieves the details of a specific connection pool.","parameters":[{"name":"connection_pool","in":"path","required":true,"schema":{"type":"string"},"description":"The connection pool identifier."},{"name":"filter[name]","in":"query","required":false,"schema":{"type":"string"},"description":"Filter results by name."},{"name":"include","in":"query","required":false,"schema":{"type":"string"},"description":"Comma-separated list of relationships to include. Available: connectors.system"},{"name":"sort","in":"query","required":false,"schema":{"type":"string"},"description":"Sort field. Prefix with - for descending. Available: name, limit, created_at"},{"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/ConnectionPoolsResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"}},"tags":["Connection Pools"]}}}}
```

## Update Connection Pool

> Updates an existing connection pool.

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Connection Pools"}],"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":{"ConnectionPoolsResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ConnectionPools"}}},"ConnectionPools":{"type":"object","properties":{"id":{"type":"integer","description":"Unique identifier"},"limit":{"type":"integer"},"timeout":{"type":"integer","items":{"type":"object"}},"created_at":{"type":"string","format":"date-time","items":{"type":"object"}},"updated_at":{"type":"string","format":"date-time","items":{"type":"object"}},"name":{"type":"string"},"connectors":{"type":"array","items":{"type":"object"}}}},"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}},"ConnectionPoolsUpdateRequest":{"type":"object","properties":{"limit":{"type":"integer","minimum":1},"timeout":{"type":"integer","minimum":1,"nullable":true},"name":{"type":"string","minLength":1,"maxLength":255}}}}},"paths":{"/api/v1/connection-pools/{connection_pool}":{"put":{"summary":"Update Connection Pool","description":"Updates an existing connection pool.","parameters":[{"name":"connection_pool","in":"path","required":true,"schema":{"type":"string"},"description":"The connection pool identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConnectionPoolsResponse"}}}},"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/ConnectionPoolsUpdateRequest"}}}},"tags":["Connection Pools"]}}}}
```

## Delete Connection Pool

> Permanently deletes a specific connection pool.

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Connection Pools"}],"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":{"MessageResponse":{"type":"object","properties":{"message":{"type":"string"}}}}},"paths":{"/api/v1/connection-pools/{connection_pool}":{"delete":{"summary":"Delete Connection Pool","description":"Permanently deletes a specific connection pool.","parameters":[{"name":"connection_pool","in":"path","required":true,"schema":{"type":"string"},"description":"The connection pool identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MessageResponse"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"}},"tags":["Connection Pools"]}}}}
```

## Clear Connection Pool

> Removes all pending requests from a specific connection pool.

```json
{"openapi":"3.0.0","info":{"title":"Patchworks Core API","version":"1.0.0"},"tags":[{"name":"Connection Pools"}],"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":{"ErrorResponse":{"type":"object","properties":{"message":{"type":"string"},"errors":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}}}}}}},"paths":{"/api/v1/connection-pools/{connection_pool}/clear":{"post":{"summary":"Clear Connection Pool","description":"Removes all pending requests from a specific connection pool.","parameters":[{"name":"connection_pool","in":"path","required":true,"schema":{"type":"string"},"description":"The connection pool identifier."}],"responses":{"200":{"description":"Successful response","content":{"application/json":{"schema":{"type":"object"}}}},"401":{"description":"Unauthenticated"},"403":{"description":"Unauthorized"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["Connection Pools"]}}}}
```