​

ves-io-schema-shape-bot_defense-threat_intelligence-bot_detection_rule-CustomAPI-GetBotDetectionRulesSummary

Published April 5, 2023 | Last modified October 28, 2026

Examples of performing bot_detection_rule CustomAPI GetBotDetectionRulesSummary

Usecase:

Get Bot Detection Rules Summary

Request:

Request using vesctl:

vesctl request rpc bot_detection_rule.CustomAPI.GetBotDetectionRulesSummary -i request.yaml --uri /public/custom/namespaces/selfservice/bot_detection_rules/summary --http-method GET

where file request.yaml has following contents:

namespace: selfservice

vesctl yaml response:

ruleSummary:
  draft:
    total: 7
  prod:
    mobile:
      "off": 20
      "on": 40
    web:
      "off": 20
      "on": 120
  test:
    mobile:
      "off": 30
      "on": 50
    web:
      "off": 30
      "on": 140

Request using curl:

curl -X 'GET' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build3348201650_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/shape/bot/custom/namespaces/selfservice/bot_detection_rules/summary?namespace=selfservice'

curl response:

HTTP/1.1 200 OK
Content-Length: 353
Content-Type: application/json
Date: Mon, 28 Sep 2026 04:28:05 GMT
Vary: Accept-Encoding


{
  "rule_summary": {
    "prod": {
      "web": {
        "on": 120,
        "off": 20
      },
      "mobile": {
        "on": 40,
        "off": 20
      }
    },
    "test": {
      "web": {
        "on": 140,
        "off": 30
      },
      "mobile": {
        "on": 50,
        "off": 30
      }
    },
    "draft": {
      "total": 7
    }
  }
}
On this page: