RouteConfig
Defined in: packages/core/src/models/route-config.ts:5
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new RouteConfig():
RouteConfig
Returns
Section titled “Returns”RouteConfig
Properties
Section titled “Properties”allowedContentTypes
Section titled “allowedContentTypes”allowedContentTypes:
string[] |null=null
Defined in: packages/core/src/models/route-config.ts:32
apiKeyHeader
Section titled “apiKeyHeader”apiKeyHeader:
string|null=null
Defined in: packages/core/src/models/route-config.ts:24
apiKeyRequired
Section titled “apiKeyRequired”apiKeyRequired:
boolean=false
Defined in: packages/core/src/models/route-config.ts:36
apiKeyVerifier
Section titled “apiKeyVerifier”apiKeyVerifier: ((
request,credential) =>unknown) |null=null
Defined in: packages/core/src/models/route-config.ts:23
authorizationHeaderRequired
Section titled “authorizationHeaderRequired”authorizationHeaderRequired:
string|null=null
Defined in: packages/core/src/models/route-config.ts:25
authRequired
Section titled “authRequired”authRequired:
string|null=null
Defined in: packages/core/src/models/route-config.ts:14
authVerifier
Section titled “authVerifier”authVerifier: ((
request,credential) =>unknown) |null=null
Defined in: packages/core/src/models/route-config.ts:22
behaviorRules
Section titled “behaviorRules”behaviorRules:
BehaviorRule[] =[]
Defined in: packages/core/src/models/route-config.ts:29
blockCloudProviders
Section titled “blockCloudProviders”blockCloudProviders:
Set<string>
Defined in: packages/core/src/models/route-config.ts:30
blockedCountries
Section titled “blockedCountries”blockedCountries:
string[] |null=null
Defined in: packages/core/src/models/route-config.ts:10
blockedUserAgents
Section titled “blockedUserAgents”blockedUserAgents:
string[] =[]
Defined in: packages/core/src/models/route-config.ts:27
bypassedChecks
Section titled “bypassedChecks”bypassedChecks:
Set<string>
Defined in: packages/core/src/models/route-config.ts:12
customValidators
Section titled “customValidators”customValidators: (
request) =>Promise<GuardResponse|null>[] =[]
Defined in: packages/core/src/models/route-config.ts:26
Parameters
Section titled “Parameters”request
Section titled “request”Returns
Section titled “Returns”Promise<GuardResponse | null>
detectionScanBody
Section titled “detectionScanBody”detectionScanBody:
boolean|null=null
Defined in: packages/core/src/models/route-config.ts:59
enabledDetectionCategories
Section titled “enabledDetectionCategories”enabledDetectionCategories:
Set<string> |null=null
Defined in: packages/core/src/models/route-config.ts:55
enableSuspiciousDetection
Section titled “enableSuspiciousDetection”enableSuspiciousDetection:
boolean=true
Defined in: packages/core/src/models/route-config.ts:34
excludedDetectionBodyFields
Section titled “excludedDetectionBodyFields”excludedDetectionBodyFields:
Set<string> |null=null
Defined in: packages/core/src/models/route-config.ts:51
excludedDetectionHeaders
Section titled “excludedDetectionHeaders”excludedDetectionHeaders:
Set<string> |null=null
Defined in: packages/core/src/models/route-config.ts:49
excludedDetectionParams
Section titled “excludedDetectionParams”excludedDetectionParams:
Set<string> |null=null
Defined in: packages/core/src/models/route-config.ts:50
geoRateLimits
Section titled “geoRateLimits”geoRateLimits:
Record<string, [number,number]> |null=null
Defined in: packages/core/src/models/route-config.ts:38
ipBlacklist
Section titled “ipBlacklist”ipBlacklist:
string[] |null=null
Defined in: packages/core/src/models/route-config.ts:9
ipWhitelist
Section titled “ipWhitelist”ipWhitelist:
string[] |null=null
Defined in: packages/core/src/models/route-config.ts:8
maxRequestSize
Section titled “maxRequestSize”maxRequestSize:
number|null=null
Defined in: packages/core/src/models/route-config.ts:31
rateLimit
Section titled “rateLimit”rateLimit:
number|null=null
Defined in: packages/core/src/models/route-config.ts:6
rateLimitWindow
Section titled “rateLimitWindow”rateLimitWindow:
number|null=null
Defined in: packages/core/src/models/route-config.ts:7
requiredHeaders
Section titled “requiredHeaders”requiredHeaders:
Record<string,string> ={}
Defined in: packages/core/src/models/route-config.ts:28
requireHttps
Section titled “requireHttps”requireHttps:
boolean=false
Defined in: packages/core/src/models/route-config.ts:13
requireReferrer
Section titled “requireReferrer”requireReferrer:
string[] |null=null
Defined in: packages/core/src/models/route-config.ts:35
sessionLimits
Section titled “sessionLimits”sessionLimits:
Record<string,number> |null=null
Defined in: packages/core/src/models/route-config.ts:37
timeRestrictions
Section titled “timeRestrictions”timeRestrictions: {
end:string;start:string; } |null=null
Defined in: packages/core/src/models/route-config.ts:33
whitelistCountries
Section titled “whitelistCountries”whitelistCountries:
string[] |null=null
Defined in: packages/core/src/models/route-config.ts:11