Enable remote syslog logging

POST

/

v2

/

api

/

enable_remote_syslog_logging

cURL

curl -sk -X POST "https://<controller>/v2/api/enable_remote_syslog_logging" \
  -H "Authorization: cid <CID>"

import requests

url = "https://<controller>/v2/api/enable_remote_syslog_logging"
headers = {"Authorization": "cid <CID>"}

response = requests.post(url, headers=headers, verify=False)
print(response.status_code)
print(response.text)

package main

import (
  "fmt"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "https://<controller>/v2/api/enable_remote_syslog_logging", nil)
  req.Header.Set("Authorization", "cid <CID>")

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  fmt.Println(resp.Status)
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}

Body

application/json

port

string

required

Remote syslog server port.

server

string

required

Remote syslog server.

CID

string

The opaque session ID token. Required for 7.2 controllers only.

action

string

The API action to perform. Required for 7.2 controllers only.

ca_certificate

string

CA certificate. This field must be base64 encoded.

exclude_gateway_list

string

Comma separated exclude gateway list.

index

integer

Forwarder index number.

name

string

Forwarder name.

private_key

string

Private key. This field must be base64 encoded.

protocol

enum<string>

UDP or TCP.

Available options:

TCP,

UDP

public_certificate

string

Public certificate. This field must be base64 encoded.

template

string

Template string for rsyslog as a file.

tls

boolean

Enable tls.

use_default_certs

boolean

Use spire certs.

Response

General v2 API response schema.

A generic API response container for v2 style APIs.

errortype

string

Error type if the API failed.

reason

string

Failure reason if the API failed.

results

API response data

return

boolean

Whether the API returned successfully

⌘I

cURL

curl -sk -X POST "https://<controller>/v2/api/enable_remote_syslog_logging" \
  -H "Authorization: cid <CID>"

import requests

url = "https://<controller>/v2/api/enable_remote_syslog_logging"
headers = {"Authorization": "cid <CID>"}

response = requests.post(url, headers=headers, verify=False)
print(response.status_code)
print(response.text)

package main

import (
  "fmt"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "https://<controller>/v2/api/enable_remote_syslog_logging", nil)
  req.Header.Set("Authorization", "cid <CID>")

  client := &http.Client{}
  resp, err := client.Do(req)
  if err != nil {
    panic(err)
  }
  defer resp.Body.Close()

  fmt.Println(resp.Status)
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}

{
  "errortype": "<string>",
  "reason": "<string>",
  "results": true,
  "return": true
}