Create log forwarding configuration

Create a new log forwarding configuration.

POST /log/forwarding

Create log forwarding configuration

cURL

curl --request POST \
  --url https://api.bunny.net/mc/log/forwarding \
  --header 'AccessKey: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "app": "<string>",
  "endpoint": "<string>",
  "port": 123,
  "enabled": true,
  "token": "<string>"
}
'

import requests

url = "https://api.bunny.net/mc/log/forwarding"

payload = {
    "app": "<string>",
    "endpoint": "<string>",
    "port": 123,
    "enabled": True,
    "token": "<string>"
}
headers = {
    "AccessKey": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {AccessKey: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    app: '<string>',
    endpoint: '<string>',
    port: 123,
    enabled: true,
    token: '<string>'
  })
};

fetch('https://api.bunny.net/mc/log/forwarding', 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.bunny.net/mc/log/forwarding",
  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([
    'app' => '<string>',
    'endpoint' => '<string>',
    'port' => 123,
    'enabled' => true,
    'token' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "AccessKey: <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.bunny.net/mc/log/forwarding"

	payload := strings.NewReader("{\n  \"app\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"port\": 123,\n  \"enabled\": true,\n  \"token\": \"<string>\"\n}")

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

	req.Header.Add("AccessKey", "<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.bunny.net/mc/log/forwarding")
  .header("AccessKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"app\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"port\": 123,\n  \"enabled\": true,\n  \"token\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.bunny.net/mc/log/forwarding")

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

request = Net::HTTP::Post.new(url)
request["AccessKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"app\": \"<string>\",\n  \"endpoint\": \"<string>\",\n  \"port\": 123,\n  \"enabled\": true,\n  \"token\": \"<string>\"\n}"

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

201

{
  "id": "<string>",
  "app": "<string>",
  "productId": "<string>",
  "endpoint": "<string>",
  "port": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "token": "<string>",
  "enabled": true
}

Authorizations

AccessKey · string · header · required

Please enter a valid personal API key.

Body

application/json

app · string · required

App unique identifier

type · enum<string> · required

Log endpoint type

Available options: SyslogUdp, SyslogTcp

endpoint · string · required

Log destination endpoint

port · integer · required

Log destination port

format · enum<string> · required

Which Syslog RFC will be used

Available options: SyslogRfc3164, SyslogRfc5424

enabled · boolean · required

Whether forwarding is enabled

token · string

Token passed as field of syslog

Response

201

application/json

Log-forwarding configuration created successfully.

id · string

Unique identifier

app · string

App unique identifier

productId · string

Product unique identifier

type · enum<string>

Log endpoint type

Available options: SyslogUdp, SyslogTcp

endpoint · string

Log destination endpoint

port · integer

Log destination port

createdAt · string<date-time>

When the configuration was created

token · string

Token passed as field of syslog

format · enum<string>

Which Syslog RFC will be used

Available options: SyslogRfc3164, SyslogRfc5424

enabled · boolean

Whether forwarding is enabled