For AI agents: a documentation index is available at the root level at /llms.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Home Guides API Reference

Home Guides API Reference

API Reference

API Reference pools.v1 PoolsService

UpdatePool

||View as Markdown|

Example request

1 {
2   "pool_id": 42,
3   "pool_name": "example",
4   "url": "example",
5   "username": "example",
6   "password": {
7     "value": "example"
8   }
9 }

Example response

1 {
2   "pool": {
3     "pool_id": 42,
4     "url": "example",
5     "username": "example",
6     "pool_name": "example"
7   }
8 }

Updates an existing pool's configuration

UpdatePoolRequest

Request

This endpoint expects an object.

pool_idlong

Unique identifier of the pool to update

pool_namestring

New pool name (optional, leave empty to keep current value)

urlstring

New pool URL (optional, leave empty to keep current value)

usernamestring

New username (optional, leave empty to keep current value)

passwordobject

New password (optional, leave empty to keep current value)

UpdatePoolResponse

Response

This endpoint returns an object.

poolobject

The updated pool with all current values