Update rate limit settings
curl --request PATCH \
--url https://api.brimble.io/core/v1/ratelimits/{projectId} \
--header 'Content-Type: application/json' \
--header 'x-brimble-key: <api-key>' \
--data '
{
"enabled": true,
"zones": [
{
"name": "<string>",
"key": "<string>",
"window": "<string>",
"events": 2,
"matcher": {
"methods": [
"<string>"
],
"paths": [
"<string>"
]
},
"ipv4Prefix": 16,
"ipv6Prefix": 64
}
],
"teamId": "<string>"
}
'import requests
url = "https://api.brimble.io/core/v1/ratelimits/{projectId}"
payload = {
"enabled": True,
"zones": [
{
"name": "<string>",
"key": "<string>",
"window": "<string>",
"events": 2,
"matcher": {
"methods": ["<string>"],
"paths": ["<string>"]
},
"ipv4Prefix": 16,
"ipv6Prefix": 64
}
],
"teamId": "<string>"
}
headers = {
"x-brimble-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-brimble-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
enabled: true,
zones: [
{
name: '<string>',
key: '<string>',
window: '<string>',
events: 2,
matcher: {methods: ['<string>'], paths: ['<string>']},
ipv4Prefix: 16,
ipv6Prefix: 64
}
],
teamId: '<string>'
})
};
fetch('https://api.brimble.io/core/v1/ratelimits/{projectId}', 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.brimble.io/core/v1/ratelimits/{projectId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'enabled' => true,
'zones' => [
[
'name' => '<string>',
'key' => '<string>',
'window' => '<string>',
'events' => 2,
'matcher' => [
'methods' => [
'<string>'
],
'paths' => [
'<string>'
]
],
'ipv4Prefix' => 16,
'ipv6Prefix' => 64
]
],
'teamId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-brimble-key: <api-key>"
],
]);
$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.brimble.io/core/v1/ratelimits/{projectId}"
payload := strings.NewReader("{\n \"enabled\": true,\n \"zones\": [\n {\n \"name\": \"<string>\",\n \"key\": \"<string>\",\n \"window\": \"<string>\",\n \"events\": 2,\n \"matcher\": {\n \"methods\": [\n \"<string>\"\n ],\n \"paths\": [\n \"<string>\"\n ]\n },\n \"ipv4Prefix\": 16,\n \"ipv6Prefix\": 64\n }\n ],\n \"teamId\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-brimble-key", "<api-key>")
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.patch("https://api.brimble.io/core/v1/ratelimits/{projectId}")
.header("x-brimble-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"enabled\": true,\n \"zones\": [\n {\n \"name\": \"<string>\",\n \"key\": \"<string>\",\n \"window\": \"<string>\",\n \"events\": 2,\n \"matcher\": {\n \"methods\": [\n \"<string>\"\n ],\n \"paths\": [\n \"<string>\"\n ]\n },\n \"ipv4Prefix\": 16,\n \"ipv6Prefix\": 64\n }\n ],\n \"teamId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.brimble.io/core/v1/ratelimits/{projectId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-brimble-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enabled\": true,\n \"zones\": [\n {\n \"name\": \"<string>\",\n \"key\": \"<string>\",\n \"window\": \"<string>\",\n \"events\": 2,\n \"matcher\": {\n \"methods\": [\n \"<string>\"\n ],\n \"paths\": [\n \"<string>\"\n ]\n },\n \"ipv4Prefix\": 16,\n \"ipv6Prefix\": 64\n }\n ],\n \"teamId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Rate limit settings updated",
"data": {
"project": "<string>",
"enabled": true,
"zones": [
{
"name": "<string>",
"key": "<string>",
"window": "<string>",
"events": 123,
"matcher": {
"methods": [
"<string>"
],
"paths": [
"<string>"
]
},
"ipv4Prefix": 123,
"ipv6Prefix": 123
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"errors": [
{
"type": "field",
"value": "<unknown>",
"msg": "Invalid value",
"path": "name",
"location": "body"
}
]
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}Scaling and Networking
Update rate limit settings
API key scope: ratelimit.update
Team role permission: ratelimit.update
PATCH
/
v1
/
ratelimits
/
{projectId}
Update rate limit settings
curl --request PATCH \
--url https://api.brimble.io/core/v1/ratelimits/{projectId} \
--header 'Content-Type: application/json' \
--header 'x-brimble-key: <api-key>' \
--data '
{
"enabled": true,
"zones": [
{
"name": "<string>",
"key": "<string>",
"window": "<string>",
"events": 2,
"matcher": {
"methods": [
"<string>"
],
"paths": [
"<string>"
]
},
"ipv4Prefix": 16,
"ipv6Prefix": 64
}
],
"teamId": "<string>"
}
'import requests
url = "https://api.brimble.io/core/v1/ratelimits/{projectId}"
payload = {
"enabled": True,
"zones": [
{
"name": "<string>",
"key": "<string>",
"window": "<string>",
"events": 2,
"matcher": {
"methods": ["<string>"],
"paths": ["<string>"]
},
"ipv4Prefix": 16,
"ipv6Prefix": 64
}
],
"teamId": "<string>"
}
headers = {
"x-brimble-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-brimble-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
enabled: true,
zones: [
{
name: '<string>',
key: '<string>',
window: '<string>',
events: 2,
matcher: {methods: ['<string>'], paths: ['<string>']},
ipv4Prefix: 16,
ipv6Prefix: 64
}
],
teamId: '<string>'
})
};
fetch('https://api.brimble.io/core/v1/ratelimits/{projectId}', 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.brimble.io/core/v1/ratelimits/{projectId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'enabled' => true,
'zones' => [
[
'name' => '<string>',
'key' => '<string>',
'window' => '<string>',
'events' => 2,
'matcher' => [
'methods' => [
'<string>'
],
'paths' => [
'<string>'
]
],
'ipv4Prefix' => 16,
'ipv6Prefix' => 64
]
],
'teamId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-brimble-key: <api-key>"
],
]);
$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.brimble.io/core/v1/ratelimits/{projectId}"
payload := strings.NewReader("{\n \"enabled\": true,\n \"zones\": [\n {\n \"name\": \"<string>\",\n \"key\": \"<string>\",\n \"window\": \"<string>\",\n \"events\": 2,\n \"matcher\": {\n \"methods\": [\n \"<string>\"\n ],\n \"paths\": [\n \"<string>\"\n ]\n },\n \"ipv4Prefix\": 16,\n \"ipv6Prefix\": 64\n }\n ],\n \"teamId\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-brimble-key", "<api-key>")
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.patch("https://api.brimble.io/core/v1/ratelimits/{projectId}")
.header("x-brimble-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"enabled\": true,\n \"zones\": [\n {\n \"name\": \"<string>\",\n \"key\": \"<string>\",\n \"window\": \"<string>\",\n \"events\": 2,\n \"matcher\": {\n \"methods\": [\n \"<string>\"\n ],\n \"paths\": [\n \"<string>\"\n ]\n },\n \"ipv4Prefix\": 16,\n \"ipv6Prefix\": 64\n }\n ],\n \"teamId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.brimble.io/core/v1/ratelimits/{projectId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-brimble-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"enabled\": true,\n \"zones\": [\n {\n \"name\": \"<string>\",\n \"key\": \"<string>\",\n \"window\": \"<string>\",\n \"events\": 2,\n \"matcher\": {\n \"methods\": [\n \"<string>\"\n ],\n \"paths\": [\n \"<string>\"\n ]\n },\n \"ipv4Prefix\": 16,\n \"ipv6Prefix\": 64\n }\n ],\n \"teamId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Rate limit settings updated",
"data": {
"project": "<string>",
"enabled": true,
"zones": [
{
"name": "<string>",
"key": "<string>",
"window": "<string>",
"events": 123,
"matcher": {
"methods": [
"<string>"
],
"paths": [
"<string>"
]
},
"ipv4Prefix": 123,
"ipv6Prefix": 123
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}{
"errors": [
{
"type": "field",
"value": "<unknown>",
"msg": "Invalid value",
"path": "name",
"location": "body"
}
]
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}{
"message": "Project not found",
"data": {}
}Authorizations
ApiKeyAuthBearerAuth
API key created in the dashboard under Settings → API keys. Each key carries permission scopes; every endpoint lists the scope it needs.
Path Parameters
Query Parameters
Team to act in. Omit for your personal workspace. API keys created for a team use that team automatically.
Pattern:
^[a-fA-F0-9]{24}$Example:
"6a81bed11470bfcd2a5dbcfa"
Body
application/json
Last modified on October 10, 2026
Was this page helpful?