Yandex Cloud
Search
Contact UsGet started
  • Blog
  • Pricing
  • Documentation
  • All Services
  • System Status
    • Featured
    • Infrastructure & Network
    • Data Platform
    • Containers
    • Developer tools
    • Serverless
    • Security
    • Monitoring & Resources
    • ML & AI
    • Business tools
  • All Solutions
    • By industry
    • By use case
    • Economics and Pricing
    • Security
    • Technical Support
    • Customer Stories
    • Start testing with double trial credits
    • Cloud credits to scale your IT product
    • Gateway to Russia
    • Cloud for Startups
    • Education and Science
    • Yandex Cloud Partner program
  • Blog
  • Pricing
  • Documentation
© 2025 Direct Cursus Technology L.L.C.
Yandex Smart Web Security
  • Getting started
    • Overview
    • Security profiles
    • WAF
    • ARL (request limit)
    • Rules
    • Conditions
    • Lists
    • Quotas and limits
  • Access management
  • Pricing policy
  • Terraform reference
    • Authentication with the API
      • Overview
        • Overview
          • Overview
          • Get
  • Monitoring metrics
  • Audit Trails events
  • Release notes

In this article:

  • HTTP request
  • Path parameters
  • Response
  • RuleDescription
  1. API reference
  2. REST
  3. SmartWebSecurity WAF API
  4. RuleSetDescriptor
  5. Get

SmartWebSecurity WAF API, REST: RuleSetDescriptor.Get

Written by
Yandex Cloud
Updated at November 26, 2024
  • HTTP request
  • Path parameters
  • Response
  • RuleDescription

Returns the specified RuleSetDescriptor resource.

HTTP requestHTTP request

GET https://smartwebsecurity.api.cloud.yandex.net/smartwebsecurity/v1/wafRuleSetDescriptors/{name}/{version}

Path parametersPath parameters

Field

Description

name

string

Required field. Name of the RuleSetDescriptor resource to return.

version

string

Required field. Version of the RuleSetDescriptor resource to return.

ResponseResponse

HTTP Code: 200 - OK

{
  "name": "string",
  "version": "string",
  "id": "string",
  "rules": [
    {
      "id": "string",
      "anomalyScore": "string",
      "paranoiaLevel": "string"
    }
  ]
}

Field

Description

name

string

Required field. Name of the rule set

version

string

Required field. Version of the rule set

id

string

Required field. ID of the rule set

rules[]

RuleDescription

List of rules

RuleDescriptionRuleDescription

Field

Description

id

string

ID of the rule

anomalyScore

string (int64)

Numeric anomaly value, i.e., a potential attack indicator.
The higher this value, the more likely it is that the request that satisfies the rule is an attack.
See documentation.

paranoiaLevel

string (int64)

Paranoia level classifies rules according to their aggression.
The higher the paranoia level, the better your protection, but also the higher the probability of WAF false positives.
See documentation.

Was the article helpful?

Previous
Overview
Next
Overview
© 2025 Direct Cursus Technology L.L.C.