Connection Pools

List Connection Pools

get

Retrieves a paginated list of connection pools.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Query parameters

filter[name]stringOptional

Filter results by name.

includestringOptional

Comma-separated list of relationships to include. Available: connectors.system

sortstringOptional

Sort field. Prefix with - for descending. Available: name, limit, created_at

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/connection-pools

HTTPcURLJavaScriptPython

GET /api/v1/connection-pools HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": 1,
      "limit": 1,
      "timeout": 1,
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "name": "My Example",
      "connectors": []
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/connection-pools",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/connection-pools?page=1",
    "last": "https://api.example.com/api/v1/connection-pools?page=1",
    "prev": null,
    "next": null
  }
}

Create Connection Pool

post

Creates a new connection pool.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Body

application/json

limitinteger · min: 1Required

timeoutinteger · min: 1 · nullableOptional

namestring · max: 255Required

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/connection-pools

HTTPcURLJavaScriptPython

POST /api/v1/connection-pools HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "limit": 1,
  "timeout": 1,
  "name": "text"
}

{
  "data": {
    "id": 1,
    "limit": 1,
    "timeout": 1,
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "name": "My Example",
    "connectors": []
  }
}

Get Connection Pool

get

Retrieves the details of a specific connection pool.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

connection_poolstringRequired

The connection pool identifier.

Query parameters

filter[name]stringOptional

Filter results by name.

includestringOptional

Comma-separated list of relationships to include. Available: connectors.system

sortstringOptional

Sort field. Prefix with - for descending. Available: name, limit, created_at

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/connection-pools/{connection_pool}

HTTPcURLJavaScriptPython

GET /api/v1/connection-pools/{connection_pool} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": 1,
    "limit": 1,
    "timeout": 1,
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "name": "My Example",
    "connectors": []
  }
}

Update Connection Pool

put

Updates an existing connection pool.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

connection_poolstringRequired

The connection pool identifier.

Body

application/json

limitinteger · min: 1Optional

timeoutinteger · min: 1 · nullableOptional

namestring · min: 1 · max: 255Optional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/connection-pools/{connection_pool}

HTTPcURLJavaScriptPython

PUT /api/v1/connection-pools/{connection_pool} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "limit": 1,
  "timeout": 1,
  "name": "text"
}

{
  "data": {
    "id": 1,
    "limit": 1,
    "timeout": 1,
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "name": "My Example",
    "connectors": []
  }
}

Delete Connection Pool

delete

Permanently deletes a specific connection pool.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

connection_poolstringRequired

The connection pool identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/connection-pools/{connection_pool}

HTTPcURLJavaScriptPython

DELETE /api/v1/connection-pools/{connection_pool} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "message": "Action completed successfully."
}

Clear Connection Pool

post

Removes all pending requests from a specific connection pool.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

connection_poolstringRequired

The connection pool identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/connection-pools/{connection_pool}/clear

HTTPcURLJavaScriptPython

POST /api/v1/connection-pools/{connection_pool}/clear HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

{}