PgBeam Docs
Agents

RevokeAgentCredential

Revoke an agent credential

Permanently revokes the credential and drops any live connections.

Usage

err := client.Agents.RevokeAgentCredential(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

error — returns nil on success.

Example

import pgbeam "go.pgbeam.com/sdk"

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

err := client.Agents.RevokeAgentCredential(ctx, "prj_xxx", "agt_xxx")
if err != nil {
  log.Fatal(err)
}

Errors

StatusDescription
400Invalid request parameters.
401Missing or invalid authentication.
403Operation not allowed by current plan limits.
404Resource not found.

On this page