x-yc-apigateway:smartWebSecurity extension

The x-yc-apigateway:smartWebSecurity extension uses rules set in the Yandex Smart Web Security security profile to protect an API gateway. For example, you can use the basic rules to block unwanted traffic or Advanced Rate Limiter to limit the number of requests.

You only pay for those requests to an API gateway that were checked and not blocked. There is a separate fee for using the security profile as per the Yandex Smart Web Security pricing policy.

Supported parametersSupported parameters

The table below lists the parameters specific to API Gateway API gateways. You can find the description of other parameters in the OpenAPI 3.0 specification.

Extension specificationExtension specification

Specification example:

openapi: "3.0.0"

x-yc-apigateway:
  smartWebSecurity:
    securityProfileId: fev6q4qqnn2q********

info:
  version: 1.0.0
  title: Protected pet store
  license:
    name: MIT
paths:
  /:
    get:
      x-yc-apigateway-integration:
        type: dummy
        content:
          '*': "This pet store is protected by SWS!"
        http_code: 200

Use casesUse cases

• Protecting API Gateway by integrating with Smart Web Security