Connection Pools Using 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 previous step, create connection pool using REST API:Â
PATCH {{url}}v1/connections/{{connection_id}}/pool
{
"name":"New Connection Pool Name"
}
Â
3. Note the pool:id in the response to the above command. This is the new connection Pool ID to be used when creating new jobs and to add more connections to the pool.
4. Add more connections (one by one) to the pool as needed.
PATCH {{url}}v1/connections/{{connection_id}}/pool
{
"id":"{{connectionPool_id}}"
}
Â
5. 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
Â