Connection Pools Using REST API

Learn how to manage connection pools using the DryvIQ REST API.


Creating a Connection Pool

  1. Create the connections that should be in a connection pool. Keep track of connection IDs.
  2. Using one of the connection IDs from the previous step, create a connection pool using the REST API.  
PATCH {{url}}v1/connections/{{connection_id}}/pool
{
    "name":"New Connection Pool Name"
}
  1. The pool:id in the response to the above command is the new connection Pool ID that needs to be used when creating new jobs and adding more connections to the pool.
  2. Add more connections (one at a time) to the pool as needed.
PATCH {{url}}v1/connections/{{connection_id}}/pool
{
    "id":"{{connectionPool_id}}"
}
  1. Create transfer job using {{connectionPool_id}} as the connection id.

Editing a Connection Pool

The Connection pool can be queried, and additional connections can be added to a connection pool using the same REST API as above.

Deleting a Connection Pool

The Connection pool can be deleted using the REST API.

DELETE {{url}}v1/connections/{{connection__id}}/pool