BareMetal API, REST: HardwarePool.List

Written by

Updated at April 21, 2026

HTTP request
Query parameters
Response
HardwarePool

Retrieves the list of HardwarePool resources.

HTTP request

GET https://baremetal.api.cloud.yandex.net/baremetal/v1alpha/hardwarePools

Query parameters

Field

Description

pageSize

string (int64)

The maximum number of results per page to return. If the number of available
results is greater than page_size,
the service returns a ListHardwarePoolsResponse.nextPageToken
that can be used to get the next page of results in subsequent list requests.
Default value is 20.

The maximum value is 1000.

pageToken

string

Page token. To get the next page of results, set page_token to the
ListHardwarePoolsResponse.nextPageToken returned by a previous list request.

Response

HTTP Code: 200 - OK

{
  "hardwarePools": [
    {
      "id": "string",
      "zoneId": "string"
    }
  ],
  "nextPageToken": "string"
}

Field

Description

hardwarePools[]

HardwarePool

List of HardwarePool resources.

nextPageToken

string

Token for getting the next page of the list. If the number of results is greater than
[ListHardwarePoolsResponse.page_size], use next_page_token as the value
for the [ListHardwarePoolsResponse.page_token] parameter in the next list request.
Each subsequent page will have its own next_page_token to continue paging through the results.

HardwarePool

A HardwarePool resource.

Field

Description

string

ID of the hardware pool.

zoneId

string

ID of the zone where the hardware pool is located.
To get the zone ID use a ZoneService.List request.

BareMetal API, REST: HardwarePool.List

HTTP requestHTTP request

Query parametersQuery parameters

ResponseResponse

HardwarePoolHardwarePool

Was the article helpful?

HTTP request

Query parameters

Response

HardwarePool