Class: AIGatewayAdminGuardrailsClient

Defined in: src/ai-gateway/admin-guardrails-client.ts:38

Explicit admin guardrail operations. No fallback to workspace routes. Only list has live read acceptance; mutations are specification-tested.

Constructors

Constructor

new AIGatewayAdminGuardrailsClient(opts): AIGatewayAdminGuardrailsClient;

Defined in: src/ai-gateway/admin-guardrails-client.ts:43

Parameters

Parameter	Type
opts	AIGatewaySubClientOptions

Returns

AIGatewayAdminGuardrailsClient

Methods

getMcpServers()

getMcpServers(guardrailId): Promise<{
[key: string]: unknown;
  id: string;
  guardrail_id: string;
  mcp_server_id: string;
  run_on: string[];
  capability_ids?: string[];
}[]>;

Defined in: src/ai-gateway/admin-guardrails-client.ts:50

List guardrail mappings to MCP servers.

Parameters

Parameter	Type
guardrailId	string

Returns

Promise<{ [key: string]: unknown; id: string; guardrail_id: string; mcp_server_id: string; run_on: string[]; capability_ids?: string[]; }[]>

Example

`await gw.adminGuardrails.getMcpServers(id);`

---

syncMcpServers()

syncMcpServers(guardrailId, body): Promise<{
[key: string]: unknown;
  changed: boolean;
  added: number;
  updated: number;
  removed: number;
}>;

Defined in: src/ai-gateway/admin-guardrails-client.ts:63

Replace all MCP server mappings on this guardrail.

Parameters

Parameter	Type
guardrailId	string
body	{ mcp_servers: Record<string, { run_on?: ("input" | "output")[]; mcp_integration_capability_ids?: string[]; }>; }
body.mcp_servers	Record<string, { run_on?: ("input" | "output")[]; mcp_integration_capability_ids?: string[]; }>

Returns

Promise<{ [key: string]: unknown; changed: boolean; added: number; updated: number; removed: number; }>

Example

`await gw.adminGuardrails.syncMcpServers(id, body);`

---

upsertMcpServer()

upsertMcpServer(
   guardrailId, 
   mcpServerId, 
   body): Promise<{
[key: string]: unknown;
  map_id: string;
}>;

Defined in: src/ai-gateway/admin-guardrails-client.ts:81

Enable or disable one MCP server mapping.

Parameters

Parameter	Type
guardrailId	string
mcpServerId	string
body	{ run_on?: ("input" | "output")[]; mcp_integration_capability_ids?: string[]; }
body.run_on?	("input" | "output")[]
body.mcp_integration_capability_ids?	string[]

Returns

Promise<{ [key: string]: unknown; map_id: string; }>

Example

`await gw.adminGuardrails.upsertMcpServer(id, serverId, body);`

---

list()

list(opts?): Promise<objectOutputType<{
  data: ZodArray<ZodObject<{
     id: ZodString;
     name: ZodString;
     slug: ZodString;
     created_at: ZodString;
     last_updated_at: ZodString;
     owner_id: ZodString;
     target: ZodOptional<ZodEnum<["llm", "mcp_tools"]>>;
     organisation_id: ZodOptional<ZodString>;
     workspace_id: ZodOptional<ZodNullable<ZodString>>;
     status: ZodOptional<ZodEnum<["active", "archived"]>>;
     updated_by: ZodOptional<ZodNullable<ZodString>>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     id: ZodString;
     name: ZodString;
     slug: ZodString;
     created_at: ZodString;
     last_updated_at: ZodString;
     owner_id: ZodString;
     target: ZodOptional<ZodEnum<["llm", "mcp_tools"]>>;
     organisation_id: ZodOptional<ZodString>;
     workspace_id: ZodOptional<ZodNullable<ZodString>>;
     status: ZodOptional<ZodEnum<["active", "archived"]>>;
     updated_by: ZodOptional<ZodNullable<ZodString>>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     id: ZodString;
     name: ZodString;
     slug: ZodString;
     created_at: ZodString;
     last_updated_at: ZodString;
     owner_id: ZodString;
     target: ZodOptional<ZodEnum<["llm", "mcp_tools"]>>;
     organisation_id: ZodOptional<ZodString>;
     workspace_id: ZodOptional<ZodNullable<ZodString>>;
     status: ZodOptional<ZodEnum<["active", "archived"]>>;
     updated_by: ZodOptional<ZodNullable<ZodString>>;
  }, ZodTypeAny, "passthrough">>, "many">;
  total: ZodNumber;
}, ZodTypeAny, "passthrough">>;

Defined in: src/ai-gateway/admin-guardrails-client.ts:101

List organisation guardrails; workspace filtering may be denied by deployment policy.

Parameters

Parameter	Type
opts	{ workspaceId?: string; pageSize?: number; currentPage?: number; }
opts.workspaceId?	string
opts.pageSize?	number
opts.currentPage?	number

Returns

Promise<objectOutputType<{ data: ZodArray<ZodObject<{ id: ZodString; name: ZodString; slug: ZodString; created_at: ZodString; last_updated_at: ZodString; owner_id: ZodString; target: ZodOptional<ZodEnum<["llm", "mcp_tools"]>>; organisation_id: ZodOptional<ZodString>; workspace_id: ZodOptional<ZodNullable<ZodString>>; status: ZodOptional<ZodEnum<["active", "archived"]>>; updated_by: ZodOptional<ZodNullable<ZodString>>; }, "passthrough", ZodTypeAny, objectOutputType<{ id: ZodString; name: ZodString; slug: ZodString; created_at: ZodString; last_updated_at: ZodString; owner_id: ZodString; target: ZodOptional<ZodEnum<["llm", "mcp_tools"]>>; organisation_id: ZodOptional<ZodString>; workspace_id: ZodOptional<ZodNullable<ZodString>>; status: ZodOptional<ZodEnum<["active", "archived"]>>; updated_by: ZodOptional<ZodNullable<ZodString>>; }, ZodTypeAny, "passthrough">, objectInputType<{ id: ZodString; name: ZodString; slug: ZodString; created_at: ZodString; last_updated_at: ZodString; owner_id: ZodString; target: ZodOptional<ZodEnum<["llm", "mcp_tools"]>>; organisation_id: ZodOptional<ZodString>; workspace_id: ZodOptional<ZodNullable<ZodString>>; status: ZodOptional<ZodEnum<["active", "archived"]>>; updated_by: ZodOptional<ZodNullable<ZodString>>; }, ZodTypeAny, "passthrough">>, "many">; total: ZodNumber; }, ZodTypeAny, "passthrough">>

Example

`await gw.adminGuardrails.list({ pageSize: 100 });`

---

get()

get(guardrailId): Promise<objectOutputType<{
  id: ZodString;
  name: ZodString;
  slug: ZodString;
  created_at: ZodString;
  last_updated_at: ZodString;
  owner_id: ZodString;
  target: ZodOptional<ZodEnum<["llm", "mcp_tools"]>>;
  organisation_id: ZodOptional<ZodString>;
  workspace_id: ZodOptional<ZodNullable<ZodString>>;
  status: ZodOptional<ZodEnum<["active", "archived"]>>;
  updated_by: ZodOptional<ZodNullable<ZodString>>;
} & {
  checks: ZodOptional<ZodArray<ZodObject<{
     id: ZodString;
     parameters: ZodOptional<ZodIntersection<ZodType<..., ..., ...>, ZodType<..., ..., ...>>>;
     is_enabled: ZodOptional<ZodBoolean>;
     name: ZodOptional<ZodString>;
   }, "passthrough", ZodTypeAny, objectOutputType<{
     id: ZodString;
     parameters: ZodOptional<ZodIntersection<..., ...>>;
     is_enabled: ZodOptional<ZodBoolean>;
     name: ZodOptional<ZodString>;
   }, ZodTypeAny, "passthrough">, objectInputType<{
     id: ZodString;
     parameters: ZodOptional<ZodIntersection<..., ...>>;
     is_enabled: ZodOptional<ZodBoolean>;
     name: ZodOptional<ZodString>;
  }, ZodTypeAny, "passthrough">>, "many">>;
  actions: ZodOptional<ZodObject<{
     deny: ZodOptional<ZodBoolean>;
     async: ZodOptional<ZodBoolean>;
     on_success: ZodOptional<ZodObject<{
        feedback: ZodOptional<...>;
      }, "strip", ZodType<GatewayJsonValue, ZodTypeDef, GatewayJsonValue>, {
        feedback?: ... | ...;
      }, {
        feedback?: ... | ...;
     }>>;
     on_fail: ZodOptional<ZodObject<{
        feedback: ZodOptional<...>;
      }, "strip", ZodType<GatewayJsonValue, ZodTypeDef, GatewayJsonValue>, {
        feedback?: ... | ...;
      }, {
        feedback?: ... | ...;
     }>>;
   }, "strip", ZodType<GatewayJsonValue, ZodTypeDef, GatewayJsonValue>, {
     deny?: boolean;
     async?: boolean;
     on_success?: {
        feedback?: {
           value: ...;
           weight: ...;
           metadata: ...;
        };
     };
     on_fail?: {
        feedback?: {
           value: ...;
           weight: ...;
           metadata: ...;
        };
     };
   }, {
     deny?: boolean;
     async?: boolean;
     on_success?: {
        feedback?: {
           value: ...;
           weight: ...;
           metadata: ...;
        };
     };
     on_fail?: {
        feedback?: {
           value: ...;
           weight: ...;
           metadata: ...;
        };
     };
  }>>;
  mcp_server_mappings: ZodOptional<ZodArray<ZodType<{
   [key: string]: unknown;
     id: string;
     guardrail_id: string;
     mcp_server_id: string;
     run_on: string[];
     capability_ids?: string[];
   }, ZodTypeDef, {
   [key: string]: unknown;
     id: string;
     guardrail_id: string;
     mcp_server_id: string;
     run_on: string[];
     capability_ids?: string[];
  }>, "many">>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/ai-gateway/admin-guardrails-client.ts:121

Read one admin guardrail.

Parameters

Parameter	Type
guardrailId	string

Returns

Promise<objectOutputType<{ id: ZodString; name: ZodString; slug: ZodString; created_at: ZodString; last_updated_at: ZodString; owner_id: ZodString; target: ZodOptional<ZodEnum<["llm", "mcp_tools"]>>; organisation_id: ZodOptional<ZodString>; workspace_id: ZodOptional<ZodNullable<ZodString>>; status: ZodOptional<ZodEnum<["active", "archived"]>>; updated_by: ZodOptional<ZodNullable<ZodString>>; } & { checks: ZodOptional<ZodArray<ZodObject<{ id: ZodString; parameters: ZodOptional<ZodIntersection<ZodType<..., ..., ...>, ZodType<..., ..., ...>>>; is_enabled: ZodOptional<ZodBoolean>; name: ZodOptional<ZodString>; }, "passthrough", ZodTypeAny, objectOutputType<{ id: ZodString; parameters: ZodOptional<ZodIntersection<..., ...>>; is_enabled: ZodOptional<ZodBoolean>; name: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">, objectInputType<{ id: ZodString; parameters: ZodOptional<ZodIntersection<..., ...>>; is_enabled: ZodOptional<ZodBoolean>; name: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">>, "many">>; actions: ZodOptional<ZodObject<{ deny: ZodOptional<ZodBoolean>; async: ZodOptional<ZodBoolean>; on_success: ZodOptional<ZodObject<{ feedback: ZodOptional<...>; }, "strip", ZodType<GatewayJsonValue, ZodTypeDef, GatewayJsonValue>, { feedback?: ... | ...; }, { feedback?: ... | ...; }>>; on_fail: ZodOptional<ZodObject<{ feedback: ZodOptional<...>; }, "strip", ZodType<GatewayJsonValue, ZodTypeDef, GatewayJsonValue>, { feedback?: ... | ...; }, { feedback?: ... | ...; }>>; }, "strip", ZodType<GatewayJsonValue, ZodTypeDef, GatewayJsonValue>, { deny?: boolean; async?: boolean; on_success?: { feedback?: { value: ...; weight: ...; metadata: ...; }; }; on_fail?: { feedback?: { value: ...; weight: ...; metadata: ...; }; }; }, { deny?: boolean; async?: boolean; on_success?: { feedback?: { value: ...; weight: ...; metadata: ...; }; }; on_fail?: { feedback?: { value: ...; weight: ...; metadata: ...; }; }; }>>; mcp_server_mappings: ZodOptional<ZodArray<ZodType<{ [key: string]: unknown; id: string; guardrail_id: string; mcp_server_id: string; run_on: string[]; capability_ids?: string[]; }, ZodTypeDef, { [key: string]: unknown; id: string; guardrail_id: string; mcp_server_id: string; run_on: string[]; capability_ids?: string[]; }>, "many">>; }, ZodTypeAny, "passthrough">>

Example

`await gw.adminGuardrails.get(id);`

---

create()

create(body): Promise<objectOutputType<{
  id: ZodString;
  slug: ZodString;
  version_id: ZodString;
}, ZodTypeAny, "passthrough">>;

Defined in: src/ai-gateway/admin-guardrails-client.ts:134

Create an admin guardrail; specification-tested, not live mutation-tested.

Parameters

Parameter	Type
body	{ name: string; target?: "llm" | "mcp_tools"; workspace_id?: string; organisation_id?: string; checks?: { id: string; parameters?: ({ [key: string]: unknown; jwksUri: string; headerKey: string; cacheMaxAge?: number | undefined; clockTolerance?: number | undefined; maxTokenAge?: string | undefined; algorithms?: string[] | undefined; } | ... 30 more ... | { ...; }) & GatewayJsonObject; is_enabled?: boolean; name?: string; }[]; actions?: { [key: string]: any; }; }
body.name	string
body.target?	"llm" | "mcp_tools"
body.workspace_id?	string
body.organisation_id?	string
body.checks?	{ id: string; parameters?: ({ [key: string]: unknown; jwksUri: string; headerKey: string; cacheMaxAge?: number | undefined; clockTolerance?: number | undefined; maxTokenAge?: string | undefined; algorithms?: string[] | undefined; } | ... 30 more ... | { ...; }) & GatewayJsonObject; is_enabled?: boolean; name?: string; }[]
body.actions?	{ [key: string]: any; }

Returns

Promise<objectOutputType<{ id: ZodString; slug: ZodString; version_id: ZodString; }, ZodTypeAny, "passthrough">>

Example

`await gw.adminGuardrails.create({ name: "Policy", target: "mcp_tools" });`

---

update()

update(guardrailId, body): Promise<objectOutputType<{
  id: ZodString;
  slug: ZodString;
  version_id: ZodOptional<ZodString>;
}, ZodTypeAny, "passthrough">>;

Defined in: src/ai-gateway/admin-guardrails-client.ts:150

Update an admin guardrail; specification-tested, not live mutation-tested.

Parameters

Parameter	Type
guardrailId	string
body	{ [key: string]: any; }

Returns

Promise<objectOutputType<{ id: ZodString; slug: ZodString; version_id: ZodOptional<ZodString>; }, ZodTypeAny, "passthrough">>

Example

`await gw.adminGuardrails.update(id, { name: "Updated policy" });`

---

delete()

delete(guardrailId): Promise<void>;

Defined in: src/ai-gateway/admin-guardrails-client.ts:168

Delete an admin guardrail; specification-tested, not live mutation-tested.

Parameters

Parameter	Type
guardrailId	string

Returns

Promise<void>

Example

`await gw.adminGuardrails.delete(id);`