Contact UsGet started
© 2025 Direct Cursus Technology L.L.C.

BareMetal API, gRPC: HardwarePoolService.List

Written by
Updated at March 28, 2025

Retrieves the list of HardwarePool resources.

gRPC request

rpc List (ListHardwarePoolsRequest) returns (ListHardwarePoolsResponse)

ListHardwarePoolsRequest

{
  "page_size": "int64",
  "page_token": "string"
}

Field

Description

page_size

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.next_page_token
that can be used to get the next page of results in subsequent list requests.
Default value is 20.

page_token

string

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

ListHardwarePoolsResponse

{
  "hardware_pools": [
    {
      "id": "string",
      "zone_id": "string"
    }
  ],
  "next_page_token": "string"
}

Field

Description

hardware_pools[]

HardwarePool

List of HardwarePool resources.

next_page_token

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

id

string

ID of the hardware pool.

zone_id

string

ID of the zone where the hardware pool is located.

To get the zone ID use a ZoneService.List request.
Previous
Get
Next
Overview