Skip to main content

Module pools_api

Module pools_api 

Source

Enums§

PoolsCreatePoolError
struct for typed errors of method pools_create_pool
PoolsDeletePoolDeprecatedError
struct for typed errors of method pools_delete_pool_deprecated
PoolsDeletePoolError
struct for typed errors of method pools_delete_pool
PoolsGetPoolsError
struct for typed errors of method pools_get_pools
PoolsReadPoolError
struct for typed errors of method pools_read_pool
PoolsUpdatePoolDeprecatedError
struct for typed errors of method pools_update_pool_deprecated
PoolsUpdatePoolError
struct for typed errors of method pools_update_pool

Functions§

pools_create_pool
Create new pool.
pools_delete_pool
Delete pool. Permissions: You can only delete empty pools (no members).
pools_delete_pool_deprecated
Delete pool (deprecated, no support for nested pools, use ‘DELETE /pools/?poolid={poolid}’). Permissions: You can only delete empty pools (no members).
pools_get_pools
List pools or get pool configuration. Permissions: List all pools where you have Pool.Audit permissions on /pool/, or the pool specific with {poolid}
pools_read_pool
Get pool configuration (deprecated, no support for nested pools, use ‘GET /pools/?poolid={poolid}’).
pools_update_pool
Update pool. Permissions: You also need the right to modify permissions on any object you add/delete.
pools_update_pool_deprecated
Update pool data (deprecated, no support for nested pools - use ‘PUT /pools/?poolid={poolid}’ instead). Permissions: You also need the right to modify permissions on any object you add/delete.