Turn a BotShield Action on or off
curl --request POST \
--url https://api.botshield.ai/operations/gates-api/actions/set-state \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"actKey": "watch",
"state": "off"
}
'import requests
url = "https://api.botshield.ai/operations/gates-api/actions/set-state"
payload = {
"actKey": "watch",
"state": "off"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({actKey: 'watch', state: 'off'})
};
fetch('https://api.botshield.ai/operations/gates-api/actions/set-state', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.botshield.ai/operations/gates-api/actions/set-state",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'actKey' => 'watch',
'state' => 'off'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.botshield.ai/operations/gates-api/actions/set-state"
payload := strings.NewReader("{\n \"actKey\": \"watch\",\n \"state\": \"off\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.botshield.ai/operations/gates-api/actions/set-state")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"actKey\": \"watch\",\n \"state\": \"off\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.botshield.ai/operations/gates-api/actions/set-state")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"actKey\": \"watch\",\n \"state\": \"off\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"data": {
"action": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Watch with passkey",
"act_key": "watch",
"where_url": "<string>",
"state": "live",
"environment": "development",
"placed_at": "2023-11-07T05:31:56Z",
"turned_off_at": "2023-11-07T05:31:56Z"
}
},
"error": {
"message": "<string>",
"statusCode": 409,
"code": "gate_key_taken"
}
}
}{
"message": "Invalid input provided",
"input": {},
"errors": [
{
"propertyPath": "<string>",
"invalidValue": "<unknown>",
"message": "<string>"
}
]
}{
"error": {
"message": "<string>",
"statusCode": 123
}
}Gates API
Turn a BotShield Action on or off
Turn an action on (live) or off by its key. Off takes effect at once — new requests are refused with action_off, and a tap in flight fails at completion. Idempotent.
POST
/
gates-api
/
actions
/
set-state
Turn a BotShield Action on or off
curl --request POST \
--url https://api.botshield.ai/operations/gates-api/actions/set-state \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"actKey": "watch",
"state": "off"
}
'import requests
url = "https://api.botshield.ai/operations/gates-api/actions/set-state"
payload = {
"actKey": "watch",
"state": "off"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({actKey: 'watch', state: 'off'})
};
fetch('https://api.botshield.ai/operations/gates-api/actions/set-state', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.botshield.ai/operations/gates-api/actions/set-state",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'actKey' => 'watch',
'state' => 'off'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.botshield.ai/operations/gates-api/actions/set-state"
payload := strings.NewReader("{\n \"actKey\": \"watch\",\n \"state\": \"off\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.botshield.ai/operations/gates-api/actions/set-state")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"actKey\": \"watch\",\n \"state\": \"off\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.botshield.ai/operations/gates-api/actions/set-state")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"actKey\": \"watch\",\n \"state\": \"off\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"data": {
"action": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Watch with passkey",
"act_key": "watch",
"where_url": "<string>",
"state": "live",
"environment": "development",
"placed_at": "2023-11-07T05:31:56Z",
"turned_off_at": "2023-11-07T05:31:56Z"
}
},
"error": {
"message": "<string>",
"statusCode": 409,
"code": "gate_key_taken"
}
}
}{
"message": "Invalid input provided",
"input": {},
"errors": [
{
"propertyPath": "<string>",
"invalidValue": "<unknown>",
"message": "<string>"
}
]
}{
"error": {
"message": "<string>",
"statusCode": 123
}
}Authorizations
Your secret server API key (bs_dev_… or bs_production_…) with Gates API access: the gates:write scope, granted in the Console under Settings → Developer Tools → API Keys. Without it every Gates API call answers gates_scope_required. The organization and environment always come from the key. Site keys are refused.
Body
application/json
Response
The action. NOTE: handler errors also arrive here (HTTP 200) as data.error — codes: invalid_key (401 — missing, malformed or inactive key), gates_scope_required (403 — the key lacks Gates API access), org_not_found (404), action_not_found (404), internal (500).
