Update Log Forwarding Configuration

NOTE: The "enabled" field should not be specified. Log forwarding will be enabled as a result of this API call. To disable log forwarding use "/api/logforwarding/disable" API

Request

URI

PUT

https://{api_host}/suite-api/api/logs/forwarding

COPY

Request Body

The log forwarding configuration data

log-forwarding-configuration of type(s) application/json

Required

Show optional properties

{
    "entities": [
        {}
    ],
    "host": "string",
    "protocol": "string",
    "cluster": "string"
}

"{\n  \"entities\" : [ \"ANALYTICS\", \"COLLECTOR\" ],\n  \"host\" : \"11.12.13.14\",\n  \"protocol\" : \"CFAPI\",\n  \"useSSL\" : true,\n  \"cluster\" : \"SampleCluster\"\n}"

boolean

enabled

Optional

Indicates whether the logs should go to external log server or not

array of string

entities

Required

Entities to forward the logs from

Possible values are : ANALYTICS, COLLECTOR, WEB, GEMFIRE, VIEW_BRIDGE, VCOPS_BRIDGE, SUITEAPI, ADMIN_UI, TOMCAT_WEBAPP, VPOSTGRES, WATCHDOG, UPGRADE, CALL_STACK, OTHER,

string

host

Required

The host to forward the logs to

string

protocol

Required

Enumeration of the forwarding protocols

Possible values are : CFAPI, SYSLOG, UNKNOWN,

integer As int32 As int32

port

Optional

The Forwarding port

The port takes default value based on the protocol and whether SSL is enabled or not:
Protocol CFAPI, SSL disabled, Default port: 9000
Protocol CFAPI, SSL enabled, Default port: 9543
Protocol SYSLOG, SSL disabled, Default port: 514
Protocol SYSLOG, SSL enabled, Default port: 6514

boolean

useSSL

Optional

Flag that indicates whether SSL protocol is used or not

string

sslCertPath

Optional

The path to certificate authority file

string

cluster

Required

The name of the cluster

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

200

The log forwarding configuration data

Returns log-forwarding-configuration of type(s) application/json

"{\n  \"enabled\" : true,\n  \"entities\" : [ \"CALL_STACK\", \"ANALYTICS\", \"COLLECTOR\", \"VIEW_BRIDGE\", \"VCOPS_BRIDGE\", \"TOMCAT_WEBAPP\", \"GEMFIRE\", \"SUITEAPI\", \"ADMIN_UI\", \"WEB\" ],\n  \"host\" : \"10.11.12.13\",\n  \"protocol\" : \"CFAPI\",\n  \"useSSL\" : false,\n  \"cluster\" : \"single\"\n}"

boolean

enabled

Optional

Indicates whether the logs should go to external log server or not

array of string

entities

Required

Entities to forward the logs from

Possible values are : ANALYTICS, COLLECTOR, WEB, GEMFIRE, VIEW_BRIDGE, VCOPS_BRIDGE, SUITEAPI, ADMIN_UI, TOMCAT_WEBAPP, VPOSTGRES, WATCHDOG, UPGRADE, CALL_STACK, OTHER,

string

host

Required

The host to forward the logs to

string

protocol

Required

Enumeration of the forwarding protocols

Possible values are : CFAPI, SYSLOG, UNKNOWN,

integer As int32 As int32

port

Optional

boolean

useSSL

Optional

Flag that indicates whether SSL protocol is used or not

string

sslCertPath

Optional

The path to certificate authority file

string

cluster

Required

The name of the cluster

Code Samples

COPY

                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"cluster:"string","entities":["string"],"host:"string","protocol:"string"}' https://{api_host}/suite-api/api/logs/forwarding

On This Page

Description

Request

Request Body

Authentication

Response

200 Response Body

Log Management Operations

GET

Get Log Forwarding Configuration

PUT

Update Log Forwarding Configuration