Update a log drain
curl --request PATCH \
--url https://api.brimble.io/core/v1/drains/{drainId} \
--header 'Content-Type: application/json' \
--header 'x-brimble-key: <api-key>' \
--data '
{
"name": "<string>",
"url": "<string>",
"enabled": true,
"headers": {},
"sources": [],
"s3": {
"storageBucketId": "<string>",
"bucket": "<string>",
"region": "<string>",
"endpoint": "<string>",
"keyPrefix": "<string>",
"accessKeyId": "<string>",
"secretAccessKey": "<string>",
"storageCredentialId": "<string>"
},
"teamId": "<string>"
}
'import requests
url = "https://api.brimble.io/core/v1/drains/{drainId}"
payload = {
"name": "<string>",
"url": "<string>",
"enabled": True,
"headers": {},
"sources": [],
"s3": {
"storageBucketId": "<string>",
"bucket": "<string>",
"region": "<string>",
"endpoint": "<string>",
"keyPrefix": "<string>",
"accessKeyId": "<string>",
"secretAccessKey": "<string>",
"storageCredentialId": "<string>"
},
"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({
name: '<string>',
url: '<string>',
enabled: true,
headers: {},
sources: [],
s3: {
storageBucketId: '<string>',
bucket: '<string>',
region: '<string>',
endpoint: '<string>',
keyPrefix: '<string>',
accessKeyId: '<string>',
secretAccessKey: '<string>',
storageCredentialId: '<string>'
},
teamId: '<string>'
})
};
fetch('https://api.brimble.io/core/v1/drains/{drainId}', 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/drains/{drainId}",
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([
'name' => '<string>',
'url' => '<string>',
'enabled' => true,
'headers' => [
],
'sources' => [
],
's3' => [
'storageBucketId' => '<string>',
'bucket' => '<string>',
'region' => '<string>',
'endpoint' => '<string>',
'keyPrefix' => '<string>',
'accessKeyId' => '<string>',
'secretAccessKey' => '<string>',
'storageCredentialId' => '<string>'
],
'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/drains/{drainId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"enabled\": true,\n \"headers\": {},\n \"sources\": [],\n \"s3\": {\n \"storageBucketId\": \"<string>\",\n \"bucket\": \"<string>\",\n \"region\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"keyPrefix\": \"<string>\",\n \"accessKeyId\": \"<string>\",\n \"secretAccessKey\": \"<string>\",\n \"storageCredentialId\": \"<string>\"\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/drains/{drainId}")
.header("x-brimble-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"enabled\": true,\n \"headers\": {},\n \"sources\": [],\n \"s3\": {\n \"storageBucketId\": \"<string>\",\n \"bucket\": \"<string>\",\n \"region\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"keyPrefix\": \"<string>\",\n \"accessKeyId\": \"<string>\",\n \"secretAccessKey\": \"<string>\",\n \"storageCredentialId\": \"<string>\"\n },\n \"teamId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.brimble.io/core/v1/drains/{drainId}")
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 \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"enabled\": true,\n \"headers\": {},\n \"sources\": [],\n \"s3\": {\n \"storageBucketId\": \"<string>\",\n \"bucket\": \"<string>\",\n \"region\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"keyPrefix\": \"<string>\",\n \"accessKeyId\": \"<string>\",\n \"secretAccessKey\": \"<string>\",\n \"storageCredentialId\": \"<string>\"\n },\n \"teamId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Log drain updated successfully",
"data": {
"id": "<string>",
"userId": "<string>",
"teamId": "<string>",
"name": "<string>",
"type": "https",
"url": "<string>",
"headerKeys": [
"<string>"
],
"s3": {
"region": "<string>",
"endpoint": "<string>",
"bucket": "<string>",
"keyPrefix": "<string>",
"storageBucketId": "6a81bed11470bfcd2a5dbcfa"
},
"sources": [
"app"
],
"status": "provisioning",
"statusReason": "<string>",
"disabledAt": "2023-11-07T05:31:56Z",
"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": {}
}Log Drains
Update a log drain
API key scope: drain.update
Team role permission: drain.update
PATCH
/
v1
/
drains
/
{drainId}
Update a log drain
curl --request PATCH \
--url https://api.brimble.io/core/v1/drains/{drainId} \
--header 'Content-Type: application/json' \
--header 'x-brimble-key: <api-key>' \
--data '
{
"name": "<string>",
"url": "<string>",
"enabled": true,
"headers": {},
"sources": [],
"s3": {
"storageBucketId": "<string>",
"bucket": "<string>",
"region": "<string>",
"endpoint": "<string>",
"keyPrefix": "<string>",
"accessKeyId": "<string>",
"secretAccessKey": "<string>",
"storageCredentialId": "<string>"
},
"teamId": "<string>"
}
'import requests
url = "https://api.brimble.io/core/v1/drains/{drainId}"
payload = {
"name": "<string>",
"url": "<string>",
"enabled": True,
"headers": {},
"sources": [],
"s3": {
"storageBucketId": "<string>",
"bucket": "<string>",
"region": "<string>",
"endpoint": "<string>",
"keyPrefix": "<string>",
"accessKeyId": "<string>",
"secretAccessKey": "<string>",
"storageCredentialId": "<string>"
},
"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({
name: '<string>',
url: '<string>',
enabled: true,
headers: {},
sources: [],
s3: {
storageBucketId: '<string>',
bucket: '<string>',
region: '<string>',
endpoint: '<string>',
keyPrefix: '<string>',
accessKeyId: '<string>',
secretAccessKey: '<string>',
storageCredentialId: '<string>'
},
teamId: '<string>'
})
};
fetch('https://api.brimble.io/core/v1/drains/{drainId}', 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/drains/{drainId}",
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([
'name' => '<string>',
'url' => '<string>',
'enabled' => true,
'headers' => [
],
'sources' => [
],
's3' => [
'storageBucketId' => '<string>',
'bucket' => '<string>',
'region' => '<string>',
'endpoint' => '<string>',
'keyPrefix' => '<string>',
'accessKeyId' => '<string>',
'secretAccessKey' => '<string>',
'storageCredentialId' => '<string>'
],
'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/drains/{drainId}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"enabled\": true,\n \"headers\": {},\n \"sources\": [],\n \"s3\": {\n \"storageBucketId\": \"<string>\",\n \"bucket\": \"<string>\",\n \"region\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"keyPrefix\": \"<string>\",\n \"accessKeyId\": \"<string>\",\n \"secretAccessKey\": \"<string>\",\n \"storageCredentialId\": \"<string>\"\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/drains/{drainId}")
.header("x-brimble-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"enabled\": true,\n \"headers\": {},\n \"sources\": [],\n \"s3\": {\n \"storageBucketId\": \"<string>\",\n \"bucket\": \"<string>\",\n \"region\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"keyPrefix\": \"<string>\",\n \"accessKeyId\": \"<string>\",\n \"secretAccessKey\": \"<string>\",\n \"storageCredentialId\": \"<string>\"\n },\n \"teamId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.brimble.io/core/v1/drains/{drainId}")
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 \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"enabled\": true,\n \"headers\": {},\n \"sources\": [],\n \"s3\": {\n \"storageBucketId\": \"<string>\",\n \"bucket\": \"<string>\",\n \"region\": \"<string>\",\n \"endpoint\": \"<string>\",\n \"keyPrefix\": \"<string>\",\n \"accessKeyId\": \"<string>\",\n \"secretAccessKey\": \"<string>\",\n \"storageCredentialId\": \"<string>\"\n },\n \"teamId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"message": "Log drain updated successfully",
"data": {
"id": "<string>",
"userId": "<string>",
"teamId": "<string>",
"name": "<string>",
"type": "https",
"url": "<string>",
"headerKeys": [
"<string>"
],
"s3": {
"region": "<string>",
"endpoint": "<string>",
"bucket": "<string>",
"keyPrefix": "<string>",
"storageBucketId": "6a81bed11470bfcd2a5dbcfa"
},
"sources": [
"app"
],
"status": "provisioning",
"statusReason": "<string>",
"disabledAt": "2023-11-07T05:31:56Z",
"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
Name cannot be empty
Maximum string length:
64Available options:
https, s3 Show child attributes
Show child attributes
Sources must be a non-empty array
Minimum array length:
1Available options:
app, system, http Show child attributes
Show child attributes
Team to act in. Omit for your personal workspace.
Pattern:
^[a-fA-F0-9]{24}$Last modified on October 10, 2026
Was this page helpful?