POST Log Forwarder

Adds a log forwarding destination.

Request

URI

POST

https://{api_host}/api/v1/log-forwarder

COPY

Request Body

forwarders.post.request of type(s) application/json

Optional

{
    "acceptCert": false,
    "name": "example",
    "host": "10.10.10.10",
    "port": 9000,
    "protocol": "cfapi",
    "sslEnabled": false,
    "workerCount": 8,
    "diskCacheSize": 104857600,
    "tags": {
        "tag1": "value1",
        "tag2": "value2"
    },
    "filter": "hostname=~\"vmware\"",
    "transportProtocol": "tcp",
    "forwardComplementaryFields": true,
    "testConnection": false
}

Authentication

This operation uses the following authentication methods.

Bearer

Responses

201

Successfully added log forwarder configuration.

Returns forwarders.get.response of type(s) application/json

{
    "name": "test1",
    "host": "10.10.10.10",
    "port": 9000,
    "protocol": "cfapi",
    "sslEnabled": false,
    "workerCount": 8,
    "connectionRefreshInterval": 60,
    "diskCacheSize": 104857600,
    "tags": {},
    "filter": "",
    "transportProtocol": "tcp",
    "forwardComplementaryFields": true,
    "id": "5a105e8b-9d40-3132-9780-d62ea2265d8a"
}

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"

409

Forwarder with specified id already exists.

Returns error of type(s) application/json

{
    "errorMessage": "Forwarder with specified name already exists.",
    "errorCode": "FIELD_ERROR",
    "errorDetails": {
        "name": "com.vmware.loginsight.api.errors.forwarding.already_exists"
    }
}

string

errorMessage

Required

A message describing the error.

string

errorCode

Optional

A code representing the type of error.

object

errorDetails

Optional

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

440

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

"Login Timeout"

495

SSL connection failed.

Returns error of type(s) application/json

{
    "errorMessage": "SSL connection failed. Forwarding destination certificate is not trusted. Use \"acceptCert\":true in request to automatically accept not trusted certificate.",
    "errorDetails": {
        "errorMessage": "SSL connection failed. Forwarding destination certificate is not trusted. Use \"acceptCert\":true in request to automatically accept not trusted certificate.",
        "errorCode": "TEST_ERROR"
    }
}

string

errorMessage

Required

A message describing the error.

string

errorCode

Optional

A code representing the type of error.

object

errorDetails

Optional

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

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/api/v1/log-forwarder

On This Page

Description

Request

Request Body

Authentication

Response

201 Response Body

Errors

Log Forwarder Operations

DELETE Log Forwarder Id

PATCH

PATCH Log Forwarder Id

POST

POST Log Forwarder Testconnection

POST

POST Log Forwarder Batch