Connection Pools

Index

get

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.

• connectors

• connectors_count

• connectorsExists

• connectors.system

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.

• name

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

• limit

• created_at

Authorizations

ApiKeyAuth

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

Store

post

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	☑
limit	integer	☑
timeout	integer

Authorizations

ApiKeyAuth

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
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "limit": 1,
  "timeout": 1,
  "name": "My Example"
}

{
  "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": []
  }
}

Show

get

Get a single connection pool.

Authorizations

ApiKeyAuth

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

put

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
limit	integer
timeout	integer

Authorizations

ApiKeyAuth

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
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "limit": 1,
  "timeout": 1,
  "name": "My Example"
}

{
  "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": []
  }
}

Destroy

delete

Delete a connection pool.

Authorizations

ApiKeyAuth

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
Accept: */*

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

Clear

post

Clear for clear.

Authorizations

ApiKeyAuth

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
Accept: */*

{}