Atlas
Admin — Connections

Drain connection pool

Drains and recreates the pool for a specific connection.

POST
/api/v1/admin/connections/{id}/drain

Path Parameters

id*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "http://localhost:3001/api/v1/admin/connections/warehouse/drain"
{
  "drained": true,
  "message": "string"
}
{
  "property1": null,
  "property2": null
}
{
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}
{
  "drained": true,
  "message": "string"
}
{
  "property1": null,
  "property2": null
}
{
  "error": "string",
  "message": "string",
  "requestId": "string"
}