v1

latestOpenAPI 3.0.42026-07-26263457588.1 KB

API Guardian

Update your API Guardian Endpoint configuration

patch/shield/shield-zone/{shieldZoneId}/api-guardian/endpoint/{endpointId}

shieldZoneIdinteger required

endpointIdinteger required

isEnabledboolean nullable

Enable or disable this endpoint. Disabled endpoints are not enforced.

validateRequestBodySchemaboolean nullable

Enable or disable request body schema validation. Only effective if the endpoint's OAS operation defines a request body schema.

validateResponseBodySchemaboolean nullable

Enable or disable response body schema validation. Only effective if the endpoint's OAS operation defines response schemas.

validateAuthorizationboolean nullable

Enable or disable enforcement of authentication requirements as defined in the OAS security schemes.

detectParameterXssboolean nullable

Enable XSS detection on the selected injection detection parameters.

detectParameterSqliboolean nullable

Enable SQL injection detection on the selected injection detection parameters.

rateLimitingEnabledboolean nullable

Enable or disable per-endpoint rate limiting.

rateLimitingType'Global' | 'IP'

rateLimitingRequestCountinteger nullable

Maximum number of requests allowed within the timeframe before blocking. Must be greater than zero.

rateLimitingTimeframe1 | 10 | 60 | 300 | 900 | 3600

1 = PerSecond 10 = PerTenSeconds 60 = PerOneMinute 300 = PerFiveMinutes 900 = PerFifteenMinutes 3600 = PerOneHour