---
title: "updateAgentCredentialStatus"
description: "Enable or disable an agent credential"
canonical: "https://pgbeam.com/docs/ts-sdk/agents/updateAgentCredentialStatus"
last-updated: "2026-10-30T02:48:39.000Z"
---

# updateAgentCredentialStatus

> Enable or disable an agent credential

URL: https://pgbeam.com/docs/ts-sdk/agents/updateAgentCredentialStatus

{/* Auto-generated from OpenAPI. Do not edit. Run `pnpm generate:sdk-docs` to regenerate. */}

Toggles the kill-switch between active and disabled. Disabling drops live connections within seconds. Revocation is terminal and cannot be undone here: a revoked credential answers 409, because revoking does not change its secrets, so putting it back to active would make the revoked password and MCP token work again. Issue a new credential instead.

## Usage

```typescript
const result = await api.agents.updateAgentCredentialStatus({
  pathParams: { project_id: "prj_xxx", agent_id: "agt_xxx" },
  body: {
    status: "active",
  },
});
```

## Parameters

| Parameter             | Type                     | Required | Description                                                                           |
| --------------------- | ------------------------ | -------- | ------------------------------------------------------------------------------------- |
| pathParams.project_id | `string`                 | Yes      | Unique project identifier (prefixed, e.g. prj_xxx).                                   |
| pathParams.agent_id   | `string`                 | Yes      | Unique agent credential identifier (prefixed, e.g. agt_xxx).                          |
| body.status           | `"active" \| "disabled"` | Yes      | Set active to re-enable or disabled to kill-switch. Use DELETE to revoke permanently. |

## Response

`Promise<AgentCredential>`: updated agent credential.

## Example

```typescript
import { PgBeamClient } from "pgbeam";

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

const result = await client.api.agents.updateAgentCredentialStatus({
  pathParams: { project_id: "prj_xxx", agent_id: "agt_xxx" },
  body: {
    status: "active",
  },
});
```

## Errors

| Status | Description                                                                                                                                                                                                                                                                                                                           |
| ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 400    | The request was rejected. `code` is `INVALID_INPUT`, and `errors` names the offending fields when the failure was a validation one.                                                                                                                                                                                                   |
| 401    | Missing or invalid authentication. `code` is `UNAUTHORIZED`.                                                                                                                                                                                                                                                                          |
| 403    | The caller is authenticated but not allowed to perform this operation. `code` is `FORBIDDEN` when the caller's role is insufficient, and `PLAN_LIMIT_REACHED` when the organization's plan is what stands in the way. The two are answered differently, so branch on the code rather than the status.                                 |
| 404    | The resource does not exist, or the caller is not entitled to know that it does. `code` is `NOT_FOUND`.                                                                                                                                                                                                                               |
| 409    | The request conflicts with the current state. `code` distinguishes the cases: `RESOURCE_EXISTS` for a name or value already in use, `INVALID_STATE` for a resource that is no longer in a state that allows the operation, and `IDEMPOTENCY_KEY_REUSED` for a retry whose body does not match the request the key was first used for. |
| 412    | The `If-Match` entity tag does not match the current representation, so the resource changed after the read this write was based on. Nothing was modified. `code` is `PRECONDITION_FAILED`. Re-read the resource, re-apply the change, and retry with the new tag.                                                                    |
| 413    | The request body exceeds the 2 MB limit. `code` is `PAYLOAD_TOO_LARGE`.                                                                                                                                                                                                                                                               |
| 415    | The request body is not JSON, or carries a body without declaring a Content-Type. `code` is `UNSUPPORTED_MEDIA_TYPE`.                                                                                                                                                                                                                 |
| 500    | The request failed for a reason on our side. `code` is `INTERNAL_ERROR`. Quote `request_id` when reporting it.                                                                                                                                                                                                                        |