Update Log Forwarding Configuration Using PUT

Update Log Forwarding Configuration Using PUT

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}/api/logs/forwarding
COPY
Request Body

The log forwarding configuration data

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

Show optional properties

{
    "cluster": "string",
    "entities": [
        {}
    ],
    "host": "string",
    "protocol": "string"
}
{
    "cluster": "string",
    "enabled": false,
    "entities": [
        "string"
    ],
    "host": "string",
    "port": 0,
    "protocol": "string",
    "sslCertPath": "string",
    "useSSL": false
}
string
cluster
Required

The name of the cluster

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

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

string
protocol
Required

The Forwarding protocol

Possible values are : CFAPI, SYSLOG, UNKNOWN,
string
sslCertPath
Optional

The path to certificate authority file

boolean
useSSL
Optional

Flag that indicates whether SSL protocol is used or not

Authentication
This operation uses the following authentication methods.
Responses
200

The log forwarding configuration data

Returns log-forwarding-configuration of type(s) application/json
{
    "cluster": "string",
    "enabled": false,
    "entities": [
        "string"
    ],
    "host": "string",
    "port": 0,
    "protocol": "string",
    "sslCertPath": "string",
    "useSSL": false
}
string
cluster
Required

The name of the cluster

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

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

string
protocol
Required

The Forwarding protocol

Possible values are : CFAPI, SYSLOG, UNKNOWN,
string
sslCertPath
Optional

The path to certificate authority file

boolean
useSSL
Optional

Flag that indicates whether SSL protocol is used or not