GET summary of bot detection rules.

GET

/api/shape/bot/custom/namespaces/{namespace}/bot_detection_rules/summary

curl --request GET \
  --url https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/shape/bot/custom/namespaces/example/bot_detection_rules/summary \
  --header 'Authorization: <Authorization>'

• F5 Distributed Cloud Console

Getbotdetectionrulessummary CustomAPI.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace x-required Namespace is used to scope the query.

Responses

200

A successful response.

Media typeapplication/json

GetBotDetectionRulesSummaryResponse

Response for GET bot detection rules summary.

object

rule_summary

object

draft

object

total

Total

Total number of rules.

integer format: int64

prod

object

mobile

object

off

Off

Number of rules which are Off.

integer format: int64

on

On

Number of rules which are On.

integer format: int64

web

object

off

Off

Number of rules which are Off.

integer format: int64

on

On

Number of rules which are On.

integer format: int64

test

object

mobile

object

off

Off

Number of rules which are Off.

integer format: int64

on

On

Number of rules which are On.

integer format: int64

web

object

off

Off

Number of rules which are Off.

integer format: int64

on

On

Number of rules which are On.

integer format: int64

Example^generated

{
  "rule_summary": {
    "draft": {
      "total": 1
    },
    "prod": {
      "mobile": {
        "off": 1,
        "on": 1
      },
      "web": {
        "off": 1,
        "on": 1
      }
    },
    "test": {
      "mobile": {
        "off": 1,
        "on": 1
      },
      "web": {
        "off": 1,
        "on": 1
      }
    }
  }
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example