PgBeam Docs
Platform

ListRegions

List available regions

Returns all active data plane regions.

Usage

result, err := client.Platform.ListRegions(ctx)

Parameters

ParameterTypeRequiredDescription
ctxcontext.ContextYesRequest context

Response

(*pgbeam.ListRegionsResponse, error) — list of regions.

Example

import pgbeam "github.com/pgbeam/pgbeam-go"

client := pgbeam.NewClient(&pgbeam.ClientOptions{
  APIKey: "pgb_your_api_key",
})

result, err := client.Platform.ListRegions(ctx)
if err != nil {
  log.Fatal(err)
}
fmt.Println(result)

Errors

StatusDescription
401Missing or invalid authentication.
429Rate limited. Try again later.

On this page