Create Log Drain

POST

log-drains

Create Log Drain

curl --request POST \
  --url https://api.hedra.com/v3/log-drains \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "format": "ndjson",
  "secret": "<string>",
  "headers": {},
  "enabled": true,
  "batch_size": 1000
}
'

import requests

url = "https://api.hedra.com/v3/log-drains"

payload = {
    "name": "<string>",
    "url": "<string>",
    "format": "ndjson",
    "secret": "<string>",
    "headers": {},
    "enabled": True,
    "batch_size": 1000
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    url: '<string>',
    format: 'ndjson',
    secret: '<string>',
    headers: {},
    enabled: true,
    batch_size: 1000
  })
};

fetch('https://api.hedra.com/v3/log-drains', 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.hedra.com/v3/log-drains",
  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([
    'name' => '<string>',
    'url' => '<string>',
    'format' => 'ndjson',
    'secret' => '<string>',
    'headers' => [
        
    ],
    'enabled' => true,
    'batch_size' => 1000
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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.hedra.com/v3/log-drains"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"url\": \"<string>\",\n  \"format\": \"ndjson\",\n  \"secret\": \"<string>\",\n  \"headers\": {},\n  \"enabled\": true,\n  \"batch_size\": 1000\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<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.post("https://api.hedra.com/v3/log-drains")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"url\": \"<string>\",\n  \"format\": \"ndjson\",\n  \"secret\": \"<string>\",\n  \"headers\": {},\n  \"enabled\": true,\n  \"batch_size\": 1000\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hedra.com/v3/log-drains")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"url\": \"<string>\",\n  \"format\": \"ndjson\",\n  \"secret\": \"<string>\",\n  \"headers\": {},\n  \"enabled\": true,\n  \"batch_size\": 1000\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "name": "<string>",
  "url": "<string>",
  "enabled": true,
  "batch_size": 123,
  "consecutive_failures": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "header_names": [
    "<string>"
  ],
  "last_success_at": "2023-11-07T05:31:56Z",
  "last_failure_at": "2023-11-07T05:31:56Z",
  "last_failure_status": 123,
  "last_error": {
    "message": "<string>",
    "retryable": false,
    "retry_after": 123,
    "param": "<string>",
    "details": [
      {
        "field": "<string>",
        "message": "<string>",
        "reason": "<string>",
        "allowed": [
          "<string>"
        ]
      }
    ],
    "replaced_by": "<string>"
  },
  "disabled_reason": "<string>",
  "updated_by_key_id": "<string>"
}

Authorizations

Authorization

string

header

required

Primary scheme: Authorization: Key <key_id>:<secret>.

Body

application/json

name

string

required

Required string length: 1 - 100

url

string

required

Required string length: 1 - 8192

format

enum<string>

default:ndjson

Wire encoding for one log drain endpoint's HTTP posts.

Available options:

ndjson,

otlp

secret

string<password> | null

write-only

Signs every NDJSON post. Required when format is ndjson (the default); optional for otlp drains, whose receivers authenticate with headers instead.

Required string length: 64 - 4096

headers

Headers · object | null

Show child attributes

enabled

boolean

default:true

batch_size

integer

default:1000

Required range: 1 <= x <= 5000

Response

Successful Response

string

required

name

string

required

url

string

required

format

enum<string>

required

Wire encoding for one log drain endpoint's HTTP posts.

Available options:

ndjson,

otlp

enabled

boolean

required

batch_size

integer

required

consecutive_failures

integer

required

created_at

string<date-time>

required

updated_at

string<date-time>

required

header_names

string[]

last_success_at

string<date-time> | null

last_failure_at

string<date-time> | null

last_failure_status

integer | null

last_error

ErrorEnvelope · object | null

Why the most recent batch delivery failed, in the same error envelope GET /jobs/{job_id} returns for a failed job: a stable code from the shared error vocabulary, a fixed operator-facing message, and retryable. Null while no batch has failed, and cleared on the next success. Destination URLs, headers, credentials, response bodies, and internal exception text are never included. Nor is your drain URL written to Hedra's own logs, since it may carry authentication in its query string. retryable describes the condition, not what Hedra did: every failed batch is requeued until the drain auto-disables, so it answers whether fixing the destination and re-enabling is likely to help. Drains that last failed before this field became structured report UNKNOWN.

Show child attributes

disabled_reason

string | null

updated_by_key_id

string | null

Get Log Drain

⌘I

Create Log Drain

curl --request POST \
  --url https://api.hedra.com/v3/log-drains \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "format": "ndjson",
  "secret": "<string>",
  "headers": {},
  "enabled": true,
  "batch_size": 1000
}
'

import requests

url = "https://api.hedra.com/v3/log-drains"

payload = {
    "name": "<string>",
    "url": "<string>",
    "format": "ndjson",
    "secret": "<string>",
    "headers": {},
    "enabled": True,
    "batch_size": 1000
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    url: '<string>',
    format: 'ndjson',
    secret: '<string>',
    headers: {},
    enabled: true,
    batch_size: 1000
  })
};

fetch('https://api.hedra.com/v3/log-drains', 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.hedra.com/v3/log-drains",
  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([
    'name' => '<string>',
    'url' => '<string>',
    'format' => 'ndjson',
    'secret' => '<string>',
    'headers' => [
        
    ],
    'enabled' => true,
    'batch_size' => 1000
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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.hedra.com/v3/log-drains"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"url\": \"<string>\",\n  \"format\": \"ndjson\",\n  \"secret\": \"<string>\",\n  \"headers\": {},\n  \"enabled\": true,\n  \"batch_size\": 1000\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<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.post("https://api.hedra.com/v3/log-drains")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"url\": \"<string>\",\n  \"format\": \"ndjson\",\n  \"secret\": \"<string>\",\n  \"headers\": {},\n  \"enabled\": true,\n  \"batch_size\": 1000\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hedra.com/v3/log-drains")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"url\": \"<string>\",\n  \"format\": \"ndjson\",\n  \"secret\": \"<string>\",\n  \"headers\": {},\n  \"enabled\": true,\n  \"batch_size\": 1000\n}"

response = http.request(request)
puts response.read_body

{
  "id": "<string>",
  "name": "<string>",
  "url": "<string>",
  "enabled": true,
  "batch_size": 123,
  "consecutive_failures": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "header_names": [
    "<string>"
  ],
  "last_success_at": "2023-11-07T05:31:56Z",
  "last_failure_at": "2023-11-07T05:31:56Z",
  "last_failure_status": 123,
  "last_error": {
    "message": "<string>",
    "retryable": false,
    "retry_after": 123,
    "param": "<string>",
    "details": [
      {
        "field": "<string>",
        "message": "<string>",
        "reason": "<string>",
        "allowed": [
          "<string>"
        ]
      }
    ],
    "replaced_by": "<string>"
  },
  "disabled_reason": "<string>",
  "updated_by_key_id": "<string>"
}