Skip to content
@guardcore

SecurityAgentConfigInput

Defined in: packages/core/src/models/agent-config.ts:31

Structural GuardAgent constructor input. Field docs live on the agent’s AgentConfig; only apiKey is required, every other field is optional so the agent defaults apply where the SecurityConfig left them unset.

Properties

Section titled “Properties”

apiKey

Section titled “apiKey”

apiKey: string

Defined in: packages/core/src/models/agent-config.ts:32

backoffFactor?

Section titled “backoffFactor?”

optional backoffFactor?: number

Defined in: packages/core/src/models/agent-config.ts:46

bufferOverflowPolicy?

Section titled “bufferOverflowPolicy?”

optional bufferOverflowPolicy?: SecurityBufferOverflowPolicy

Defined in: packages/core/src/models/agent-config.ts:41

bufferSize?

Section titled “bufferSize?”

optional bufferSize?: number

Defined in: packages/core/src/models/agent-config.ts:35

compressionEnabled?

Section titled “compressionEnabled?”

optional compressionEnabled?: boolean

Defined in: packages/core/src/models/agent-config.ts:51

compressionThreshold?

Section titled “compressionThreshold?”

optional compressionThreshold?: number

Defined in: packages/core/src/models/agent-config.ts:52

dynamicRuleInterval?

Section titled “dynamicRuleInterval?”

optional dynamicRuleInterval?: number

Defined in: packages/core/src/models/agent-config.ts:37

enableEvents?

Section titled “enableEvents?”

optional enableEvents?: boolean

Defined in: packages/core/src/models/agent-config.ts:43

enableMetrics?

Section titled “enableMetrics?”

optional enableMetrics?: boolean

Defined in: packages/core/src/models/agent-config.ts:42

endpoint?

Section titled “endpoint?”

optional endpoint?: string

Defined in: packages/core/src/models/agent-config.ts:33

flushInterval?

Section titled “flushInterval?”

optional flushInterval?: number

Defined in: packages/core/src/models/agent-config.ts:36

guardCoreVersion?

Section titled “guardCoreVersion?”

optional guardCoreVersion?: string | null

Defined in: packages/core/src/models/agent-config.ts:50

guardVersion?

Section titled “guardVersion?”

optional guardVersion?: string | null

Defined in: packages/core/src/models/agent-config.ts:49

highWatermarkRatio?

Section titled “highWatermarkRatio?”

optional highWatermarkRatio?: number

Defined in: packages/core/src/models/agent-config.ts:39

installId?

Section titled “installId?”

optional installId?: string | null

Defined in: packages/core/src/models/agent-config.ts:53

maxConcurrentFlushes?

Section titled “maxConcurrentFlushes?”

optional maxConcurrentFlushes?: number

Defined in: packages/core/src/models/agent-config.ts:40

maxPayloadSize?

Section titled “maxPayloadSize?”

optional maxPayloadSize?: number

Defined in: packages/core/src/models/agent-config.ts:48

onError?

Section titled “onError?”

optional onError?: SecurityErrorHook

Defined in: packages/core/src/models/agent-config.ts:56

payloadSigningSecret?

Section titled “payloadSigningSecret?”

optional payloadSigningSecret?: string | null

Defined in: packages/core/src/models/agent-config.ts:54

projectEncryptionKey?

Section titled “projectEncryptionKey?”

optional projectEncryptionKey?: string | null

Defined in: packages/core/src/models/agent-config.ts:55

projectId?

Section titled “projectId?”

optional projectId?: string | null

Defined in: packages/core/src/models/agent-config.ts:34

retryAttempts?

Section titled “retryAttempts?”

optional retryAttempts?: number

Defined in: packages/core/src/models/agent-config.ts:44

sensitiveHeaders?

Section titled “sensitiveHeaders?”

optional sensitiveHeaders?: string[]

Defined in: packages/core/src/models/agent-config.ts:47

statusInterval?

Section titled “statusInterval?”

optional statusInterval?: number

Defined in: packages/core/src/models/agent-config.ts:38

timeout?

Section titled “timeout?”

optional timeout?: number

Defined in: packages/core/src/models/agent-config.ts:45