> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://api-docs.botbye.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api-docs.botbye.com/_mcp/server. # create POST {base_url}/api/v1/{account_id}/projects/{project_id}/rules Content-Type: application/json ### Create Project Rule This endpoint allows the user to create a new rule for a specific project within their account. #### Request Body - `name` (string): The name of the rule. - `action` (string): The action to be performed by the rule (e.g., "block"). - `isActive` (boolean): Indicates whether the rule is active or not. - `condition` (object): The condition that triggers the rule. - `fieldName` (string): The field name to be evaluated. - `predicate` (string): The comparison predicate (e.g., "EQ" for equal). - `value` (string): The value to compare against. - `type` (string): The type of condition (e.g., "criteria"). #### Response The response for this request is a JSON object representing the created rule. As per user's request, the JSON schema for the response is as follows: ``` json { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "action": { "type": "string" }, "isActive": { "type": "boolean" }, "condition": { "type": "object", "properties": { "fieldName": { "type": "string" }, "predicate": { "type": "string" }, "value": { "type": "string" }, "type": { "type": "string" } } } } } ``` Reference: https://api-docs.botbye.com/bot-bye-api/protection/custom-rules/create ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: collection version: 1.0.0 paths: /api/v1/{account_id}/projects/{project_id}/rules: post: operationId: create summary: create description: >- ### Create Project Rule This endpoint allows the user to create a new rule for a specific project within their account. #### Request Body - `name` (string): The name of the rule. - `action` (string): The action to be performed by the rule (e.g., "block"). - `isActive` (boolean): Indicates whether the rule is active or not. - `condition` (object): The condition that triggers the rule. - `fieldName` (string): The field name to be evaluated. - `predicate` (string): The comparison predicate (e.g., "EQ" for equal). - `value` (string): The value to compare against. - `type` (string): The type of condition (e.g., "criteria"). #### Response The response for this request is a JSON object representing the created rule. As per user's request, the JSON schema for the response is as follows: ``` json { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "action": { "type": "string" }, "isActive": { "type": "boolean" }, "condition": { "type": "object", "properties": { "fieldName": { "type": "string" }, "predicate": { "type": "string" }, "value": { "type": "string" }, "type": { "type": "string" } } } } } ``` tags: - subpackage_customRules parameters: - name: account_id in: path required: true schema: type: string - name: project_id in: path required: true schema: type: string responses: '200': description: success content: application/json: schema: type: string format: uuid requestBody: content: application/json: schema: type: object properties: {} servers: - url: '{base_url}' description: '{base_url}' ``` ## Examples **Request** ```json "{\n \"name\": \"{$randomProductName}\",\n \"action\": \"block\",\n \"isActive\": {$randomBoolean},\n \"condition\": {\n \"fieldName\": \"remote_addr\",\n \"predicate\": \"EQ\",\n \"value\": \"{$randomIP}\",\n \"type\": \"criteria\"\n }\n}" ``` **Response** ```json "01919a48-f7d0-78e6-8758-0bd633d40181" ``` **SDK Code** ```python Custom rules_create_example import requests url = "https://{base_url}/api/v1/account_id/projects/project_id/rules" payload = "{ \"name\": \"{$randomProductName}\", \"action\": \"block\", \"isActive\": {$randomBoolean}, \"condition\": { \"fieldName\": \"remote_addr\", \"predicate\": \"EQ\", \"value\": \"{$randomIP}\", \"type\": \"criteria\" } }" headers = {"Content-Type": "application/json"} response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Custom rules_create_example const url = 'https://{base_url}/api/v1/account_id/projects/project_id/rules'; const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '"{\n \"name\": \"{$randomProductName}\",\n \"action\": \"block\",\n \"isActive\": {$randomBoolean},\n \"condition\": {\n \"fieldName\": \"remote_addr\",\n \"predicate\": \"EQ\",\n \"value\": \"{$randomIP}\",\n \"type\": \"criteria\"\n }\n}"' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Custom rules_create_example package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://{base_url}/api/v1/account_id/projects/project_id/rules" payload := strings.NewReader("\"{\\n \\\"name\\\": \\\"{$randomProductName}\\\",\\n \\\"action\\\": \\\"block\\\",\\n \\\"isActive\\\": {$randomBoolean},\\n \\\"condition\\\": {\\n \\\"fieldName\\\": \\\"remote_addr\\\",\\n \\\"predicate\\\": \\\"EQ\\\",\\n \\\"value\\\": \\\"{$randomIP}\\\",\\n \\\"type\\\": \\\"criteria\\\"\\n }\\n}\"") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Custom rules_create_example require 'uri' require 'net/http' url = URI("https://{base_url}/api/v1/account_id/projects/project_id/rules") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Content-Type"] = 'application/json' request.body = "\"{\\n \\\"name\\\": \\\"{$randomProductName}\\\",\\n \\\"action\\\": \\\"block\\\",\\n \\\"isActive\\\": {$randomBoolean},\\n \\\"condition\\\": {\\n \\\"fieldName\\\": \\\"remote_addr\\\",\\n \\\"predicate\\\": \\\"EQ\\\",\\n \\\"value\\\": \\\"{$randomIP}\\\",\\n \\\"type\\\": \\\"criteria\\\"\\n }\\n}\"" response = http.request(request) puts response.read_body ``` ```java Custom rules_create_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://{base_url}/api/v1/account_id/projects/project_id/rules") .header("Content-Type", "application/json") .body("\"{\\n \\\"name\\\": \\\"{$randomProductName}\\\",\\n \\\"action\\\": \\\"block\\\",\\n \\\"isActive\\\": {$randomBoolean},\\n \\\"condition\\\": {\\n \\\"fieldName\\\": \\\"remote_addr\\\",\\n \\\"predicate\\\": \\\"EQ\\\",\\n \\\"value\\\": \\\"{$randomIP}\\\",\\n \\\"type\\\": \\\"criteria\\\"\\n }\\n}\"") .asString(); ``` ```php Custom rules_create_example request('POST', 'https://{base_url}/api/v1/account_id/projects/project_id/rules', [ 'body' => '"{\\n \\"name\\": \\"{$randomProductName}\\",\\n \\"action\\": \\"block\\",\\n \\"isActive\\": {$randomBoolean},\\n \\"condition\\": {\\n \\"fieldName\\": \\"remote_addr\\",\\n \\"predicate\\": \\"EQ\\",\\n \\"value\\": \\"{$randomIP}\\",\\n \\"type\\": \\"criteria\\"\\n }\\n}"', 'headers' => [ 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp Custom rules_create_example using RestSharp; var client = new RestClient("https://{base_url}/api/v1/account_id/projects/project_id/rules"); var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "\"{\\n \\\"name\\\": \\\"{$randomProductName}\\\",\\n \\\"action\\\": \\\"block\\\",\\n \\\"isActive\\\": {$randomBoolean},\\n \\\"condition\\\": {\\n \\\"fieldName\\\": \\\"remote_addr\\\",\\n \\\"predicate\\\": \\\"EQ\\\",\\n \\\"value\\\": \\\"{$randomIP}\\\",\\n \\\"type\\\": \\\"criteria\\\"\\n }\\n}\"", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Custom rules_create_example import Foundation let headers = ["Content-Type": "application/json"] let parameters = "{ \"name\": \"{$randomProductName}\", \"action\": \"block\", \"isActive\": {$randomBoolean}, \"condition\": { \"fieldName\": \"remote_addr\", \"predicate\": \"EQ\", \"value\": \"{$randomIP}\", \"type\": \"criteria\" } }" as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://{base_url}/api/v1/account_id/projects/project_id/rules")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```