PgBeam Docs
Policies

GetPolicyProfile

Get a policy profile

Returns a single policy profile by ID.

Usage

result, err := client.Policies.GetPolicyProfile(ctx, "prj_xxx", "pol_xxx")

Parameters

ParameterTypeRequiredDescription
ctxcontext.ContextYesRequest context
projectIDstringYesUnique project identifier (prefixed, e.g. prj_xxx).
policyIDstringYesUnique policy profile identifier (prefixed, e.g. pol_xxx).

Response

(*pgbeam.PolicyProfile, error) — the policy profile.

Example

import pgbeam "go.pgbeam.com/sdk"

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

result, err := client.Policies.GetPolicyProfile(ctx, "prj_xxx", "pol_xxx")
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.

On this page