GET Log Forwarder

GET Log Forwarder

Gets a list of log forwarding destinations.

Request
URI
GET
https://{api_host}/api/v1/log-forwarder
COPY
Query Parameters
boolean
showDetails
Optional
Constraints: default: false

Indicates whether to include extended information in the forwarder result, such as forwarder stats (state, logsForwarded, logsDropped, rate).

Authentication
This operation uses the following authentication methods.
Responses
200

Successfully retrieved log forwarding configurations.

Returns Array of forwarders.get.response of type(s) application/json 
[
    {
        "name": "test 1",
        "host": "10.10.10.10",
        "port": 9543,
        "protocol": "cfapi",
        "sslEnabled": true,
        "workerCount": 3,
        "connectionRefreshInterval": 60,
        "diskCacheSize": 1000000000,
        "tags": {
            "tag1": "value1"
        },
        "filter": "",
        "forwardComplementaryFields": true,
        "id": "d8198acb-dde9-3a0a-90dd-995b68554dc8",
        "forwarderStats": {
            "state": "ACTIVE",
            "rate": 1.4,
            "logsForwarded": 84,
            "logsDropped": 0
        }
    },
    {
        "name": "test 2",
        "host": "10.10.10.12",
        "port": 9543,
        "protocol": "cfapi",
        "sslEnabled": true,
        "workerCount": 3,
        "connectionRefreshInterval": 60,
        "diskCacheSize": 1000000000,
        "tags": {},
        "filter": "",
        "forwardComplementaryFields": true,
        "id": "ad2be1d1-ba1c-3242-8328-f0346be3c7db",
        "forwarderStats": {
            "state": "ACTIVE",
            "rate": 1.4,
            "logsForwarded": 84,
            "logsDropped": 0
        }
    },
    {
        "name": "test 3",
        "host": "10.10.10.13",
        "port": 9543,
        "protocol": "cfapi",
        "sslEnabled": false,
        "workerCount": 3,
        "connectionRefreshInterval": 60,
        "diskCacheSize": 1000000000,
        "tags": {},
        "filter": "",
        "forwardComplementaryFields": true,
        "id": "7ba323c5-97a9-33b4-8c34-94947abe9659",
        "forwarderStats": {
            "state": "IDLE",
            "rate": 0,
            "logsForwarded": 0,
            "logsDropped": 0
        }
    }
]

400

The request failed because the request body either did not contain valid JSON, or did not match the required JSON format.

Returns error of type(s) application/json 
{
    "errorMessage": "Invalid request body.",
    "errorCode": "JSON_FORMAT_ERROR",
    "errorDetails": {
        "reason": "..."
    }
}
string
errorMessage
Required

A message describing the error.

string
errorCode
Optional

A code representing the type of error.

Possible values are : LIMIT_ERROR, FIELD_ERROR, TEST_ERROR, JSON_FORMAT_ERROR, LICENSE_ERROR, VSPHERE_INTEGRATION_ERROR, VROPS_INTEGRATION_ERROR, UPGRADE_ERROR, SEARCH_ERROR, AGENT_ERROR, RBAC_COMMON_ERROR, RBAC_USERS_ERROR, RBAC_GROUPS_ERROR, RBAC_ADGROUPS_ERROR, RBAC_DATASETS_ERROR, RBAC_VIDM_GROUPS_ERROR, RBAC_VIDB_GROUPS_ERROR, SECURITY_ERROR, DEPLOYMENT_ERROR, SUPPORT_BUNDLE_ERROR, LOAD_BALANCER_ERROR, VIDM_ERROR, VIDB_ERROR, QUERY_ERROR, SSL_CERTIFICATE_ERROR, PROXY_ERROR,
object
errorDetails
Optional

Dynamic error details, where the field name can vary depending on the request field and error code.


401

The request was refused because it lacks valid authentication credentials. This can happen if the Authorization header was missing, or if it contained an invalid session ID.

Obtain a new session ID and retry the request, or make an unauthenticated request without the Authorization header.

"Invalid session ID"

440

The request was refused because the session ID has expired. Obtain a new session ID from /api/v1/sessions.

"Login Timeout"

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v1/log-forwarder
On This Page
Log Forwarder Operations
GET
GET Log Forwarder
POST
POST Log Forwarder
GET
GET Log Forwarder Id
PUT
PUT Log Forwarder Id
DELETE
DELETE Log Forwarder Id
PATCH
PATCH Log Forwarder Id
POST
POST Log Forwarder Testconnection
POST
POST Log Forwarder Batch