PgBeam Docs
Platform

listRegions

List available regions

Returns all active data plane regions.

Usage

const result = await api.platform.listRegions();

Parameters

None.

Response

Promise<ListRegionsResponse> — list of regions.

Example

import { PgBeamClient } from "pgbeam";

const client = new PgBeamClient({
  token: null,
  baseUrl: "https://api.pgbeam.com",
});

const result = await client.api.platform.listRegions();

Errors

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

On this page