Pools

Mark a pool as draining

Changed on
post/api/v1/pools/{name}/drain

Request

  • Base URL: http://localhost:8081
  • URL: http://localhost:8081/api/v1/pools/{name}/drain
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Request body

timeout_secondsinteger

Response

Pool drain started

namestring required
statusstring required
requiresstring[]
descriptionstring
drain_started_atstring date-time
drain_timeout_secondsinteger

Changes

  • 12120aad0bfeRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status