SDK: guard

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).

guardApprovalsAnswer

Answer a guardrail approval

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

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}

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

guardApprovalsList

List guardrail approvals

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

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

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

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

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

guardScan

Scan text for secrets

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

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