PgBeam Docs
Agents

GetAgentCredential

Get an agent credential

Returns a single agent credential. Secrets are never included.

Usage

result, err := client.Agents.GetAgentCredential(ctx, "prj_xxx", "agt_xxx")

Parameters

ParameterTypeRequiredDescription
ctxcontext.ContextYesRequest context
projectIDstringYesUnique project identifier (prefixed, e.g. prj_xxx).
agentIDstringYesUnique agent credential identifier (prefixed, e.g. agt_xxx).

Response

(*pgbeam.AgentCredential, error) — the agent credential (no secrets).

Example

import pgbeam "go.pgbeam.com/sdk"

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

result, err := client.Agents.GetAgentCredential(ctx, "prj_xxx", "agt_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