PgBeam Docs
Projects

ListCustomDomains

List custom domains

Lists all custom domains registered for the project.

Usage

result, err := client.Projects.ListCustomDomains(ctx, nil)

Parameters

ParameterTypeRequiredDescription
ctxcontext.ContextYesRequest context
params*pgbeam.ListCustomDomainsParamsNoQuery parameters
params.PageSizeintNoMaximum number of items to return (1-100, default 20).
params.PageTokenstringNoOpaque token for cursor-based pagination.

Response

(*pgbeam.ListCustomDomainsResponse, error) — list of custom domains.

Example

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

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

result, err := client.Projects.ListCustomDomains(ctx, &pgbeam.ListCustomDomainsParams{
    PageSize: 20,
    PageToken: "...",
  })
if err != nil {
  log.Fatal(err)
}
fmt.Println(result)

Errors

StatusDescription
400Invalid request parameters.
401Missing or invalid authentication.
403Operation not allowed by current plan limits.
404Resource not found.
429Rate limited. Try again later.

On this page