Save draft.

POST

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

curl --request POST \
  --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/draft \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "comments": "example", "config_change_per_bot_detection_rule": [ { "deploy_to": [ "PRODUCTION" ], "desired_rule_config": { "mitigation": true }, "desired_rule_config_per_bot_infra": [ { "bot_detection_rule_config": { "mitigation": true }, "bot_infra_id": "example", "bot_infra_name": "example", "bot_infrastructure_type": "BOT_INFRA_TYPE_UNKNOWN", "environment_type": "PRODUCTION", "region_rule_config": { "region_config": {} } } ], "existing_rule_config_per_bot_infra": [ { "bot_detection_rule_config": { "mitigation": true }, "bot_infra_id": "example", "bot_infra_name": "example", "bot_infrastructure_type": "BOT_INFRA_TYPE_UNKNOWN", "environment_type": "PRODUCTION", "region_rule_config": { "region_config": {} } } ], "last_modified_at": "2026-04-15T12:00:00Z", "reason": { "comments": "example", "reasons": [ "BOT_DETECTION_RULE_CHANGE_REASON_UNKNOWN" ] }, "rule_id": "example", "rule_name": "example", "traffic_type": "WEB" } ], "namespace": "example" }'

• F5 Distributed Cloud Console

Savedraft CustomAPI.

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace

x-required namespace is used to scope the query.

Request Body^required

Media typeapplication/json

DeployBotDetectionRulesRequest

Request for deploy bot detection rules.

object

comments

Comments

Deployment Comments.

string

<= 1024 characters

config_change_per_bot_detection_rule

Config Change Per Bot Detection Rules

Config change per bot detection rules

Required: YES.

Array<object>

BotDetectionRuleConfigChange

Bot Detection Rule Config Change.

object

deploy_to

Deploy To

Environments to which new rule configuration has to be deployed onto.

Array<string>

Allowed values: PRODUCTION TESTING

desired_rule_config

object

mitigation

Mitigation

Mitigation - true(ON) / false(OFF)

boolean format: boolean

desired_rule_config_per_bot_infra

Desired Rule Configuration Per Bot Infra

Rule or policy definition

Array<object>

BotDetectionRuleConfigPerBotInfra

Bot detection rule configuration per bot infrastructure.

object

bot_detection_rule_config

object

mitigation

Mitigation

Mitigation - true(ON) / false(OFF)

boolean format: boolean

bot_infra_id

Bot Infrastructure ID

Bot Infrastructure ID as per SAPI’s database.

string

<= 1024 characters

bot_infra_name

BotInfraName

Name of the bot infrastructure as per SAPI’s database.

string

<= 1024 characters

bot_infrastructure_type

string

default: BOT_INFRA_TYPE_UNKNOWN

Allowed values: BOT_INFRA_TYPE_UNKNOWN BOT_INFRA_TYPE_CLOUD_HOSTED BOT_INFRA_TYPE_HOSTED BOT_INFRA_TYPE_ON_PREM

environment_type

string

default: PRODUCTION

Allowed values: PRODUCTION TESTING

region_rule_config

object

region_config

Rule Config Per Region

Required: YES.

object

existing_rule_config_per_bot_infra

Existing Rule Configuration Per Bot Infra

Rule or policy definition

Array<object>

BotDetectionRuleConfigPerBotInfra

Bot detection rule configuration per bot infrastructure.

object

bot_detection_rule_config

object

mitigation

Mitigation

Mitigation - true(ON) / false(OFF)

boolean format: boolean

bot_infra_id

Bot Infrastructure ID

Bot Infrastructure ID as per SAPI’s database.

string

<= 1024 characters

bot_infra_name

BotInfraName

Name of the bot infrastructure as per SAPI’s database.

string

<= 1024 characters

bot_infrastructure_type

string

default: BOT_INFRA_TYPE_UNKNOWN

Allowed values: BOT_INFRA_TYPE_UNKNOWN BOT_INFRA_TYPE_CLOUD_HOSTED BOT_INFRA_TYPE_HOSTED BOT_INFRA_TYPE_ON_PREM

environment_type

string

default: PRODUCTION

Allowed values: PRODUCTION TESTING

region_rule_config

object

region_config

Rule Config Per Region

Required: YES.

object

last_modified_at

Last Modified At

Last Modified At as per SAPI’s database.

string format: date-time

<= 1024 characters

reason

object

comments

Comments

Comments are required when the reason type is selected as ‘Other’

string

<= 1024 characters

reasons

Reasons

List of reasons why the rule configuration is changed.

Array<string>

Allowed values: BOT_DETECTION_RULE_CHANGE_REASON_UNKNOWN BOT_DETECTION_RULE_CHANGE_REASON_FALSE_POSITIVE BOT_DETECTION_RULE_CHANGE_REASON_TRUE_POSITIVE BOT_DETECTION_RULE_CHANGE_REASON_TESTING BOT_DETECTION_RULE_CHANGE_REASON_OTHER

rule_id

Rule ID

Unique identifier for a bot detection rule as per SAPI’s database.

string

<= 1024 characters

rule_name

Rule Name

Human-readable name for the resource

string

<= 1024 characters

traffic_type

string

default: WEB

Allowed values: WEB MOBILE

namespace

namespace

Namespace is used to scope the query Required: YES.

string

>= 1 characters <= 1024 characters

Responses

200

A successful response.

Media typeapplication/json

SaveDraftResponse

Response for save draft.

object

Example^generated

{}

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