Sign in
Pool API

Get Pools

Changed on

Returns information regarding pools to users.

If all_pools is set to true, all pools' information will be returned in API response. Otherwise, only information from pools that the user has access to will be returned in the response.

get/api/pool

Request

  • The document declares no server URL.
  • Auth: none declared

Query parameters

all_poolsboolean
poolsstring[] nullable

Response

Successful Response

poolsobject

Changes

  • b9d312a13f5dRevision changes
    • ○

      added the optional property // to the response with the status

    • ○

      added the optional property // to the response with the status

  • a8157dc3279dRevision changes
    • ▲

      response property pools/additionalProperties/default_platform list-of-types was widened by adding types null to media type application/json of response 200

    • ▲

      the // response's property type changed from string to no type for status

    • ▲

      the // response's property type changed from no type to object for status

    • ○

      query request parameter pools list-of-types was widened by adding types null

    • ○

      for the query request parameter pools, the type was generalized from array to no type

    • ○

      added the optional property /// to the response with the status

    • ○

      removed from the // response property allOf list for the response status

    • ○

      added subschema #2 to the // response property anyOf list for the response status

    • ○

      added subschema #2 to the // response property anyOf list for the response status

    • ○

      removed the MAINTENANCE enum value from the // response property for the response status

    • ○

      removed the OFFLINE enum value from the // response property for the response status

    • ○

      removed the ONLINE enum value from the // response property for the response status

    • ○

      removed the download enum value from the // response property for the response status