---
title: "SDK: guard"
description: "The guard methods of the Overlane TypeScript SDK, with their signatures. Generated from the SDK types."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.overlane.app/llms.txt
> Use this file to discover all available pages before exploring further.

# SDK: guard

{/* Generated by apps/docs/scripts/generate.mjs (SDK pages from the TypeScript types in packages/sdk). Do not edit; run `pnpm --filter @overlane/docs gen`. */}

The `guard` area has 7 methods on the client. Each takes one object of path, query and body arguments and an optional `CallOptions`, and returns a promise of the response body. A refused call rejects with `OverlaneApiError` (see the [SDK index](/sdk/)).

## guardApprovalsAnswer

Answer a guardrail approval

- Request: `POST` on `/v1/tenants/{tenantId}/guard/approvals/{approvalId}/answer`

```ts
guardApprovalsAnswer(args: { tenantId: string; approvalId: string; body: AnswerGuardApprovalRequest }, options?: CallOptions): Promise<GuardApproval>
```

## guardApprovalsGet

Read one guardrail approval

- Request: `GET` on `/v1/tenants/{tenantId}/guard/approvals/{approvalId}`

```ts
guardApprovalsGet(args: { tenantId: string; approvalId: string }, options?: CallOptions): Promise<Record<string, unknown>>
```

## guardApprovalsList

List guardrail approvals

- Request: `GET` on `/v1/tenants/{tenantId}/guard/approvals`

```ts
guardApprovalsList(args: { tenantId: string }, options?: CallOptions): Promise<Record<string, unknown>>
```

## guardEvaluate

Evaluate an action against the rules

- Request: `POST` on `/v1/tenants/{tenantId}/guard/evaluate`

```ts
guardEvaluate(args: { tenantId: string; query?: { projectId?: string }; body: GuardEvaluateRequest }, options?: CallOptions): Promise<GuardEvaluateResponse>
```

## guardRulesGet

Read the guardrail rule layers

- Request: `GET` on `/v1/tenants/{tenantId}/guard/rules`

```ts
guardRulesGet(args: { tenantId: string; query?: { projectId?: string } }, options?: CallOptions): Promise<GuardRulesResponse>
```

## guardRulesPut

Replace a guardrail rule layer

- Request: `PUT` on `/v1/tenants/{tenantId}/guard/rules`

```ts
guardRulesPut(args: { tenantId: string; body: PutGuardRuleFileRequest }, options?: CallOptions): Promise<GuardRuleFileRecord>
```

## guardScan

Scan text for secrets

- Request: `POST` on `/v1/tenants/{tenantId}/guard/scan`

```ts
guardScan(args: { tenantId: string; body?: Record<string, unknown> }, options?: CallOptions): Promise<SecretScanResult>
```

Source: https://docs.overlane.app/sdk/guard/index.mdx