PATCH Log Forwarder Id

Updates the settings of a log forwarding destination.

Request

URI

PATCH

https://{api_host}/api/v2/log-forwarder/{id}

COPY

Path Parameters

string

Required

The unique identifier of a forwarding configuration. This is the id value returned from the [GET /api/v2/log-forwarder/] API.

Request Body

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

Optional

{
    "host": "10.10.10.10",
    "port": 9000,
    "protocol": "cfapi",
    "workerCount": 8,
    "diskCacheSize": 104857600,
    "forwardComplementaryFields": true
}

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Successfully updated 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

Operation doesn't return any data structure

404

No such forwarder to edit

Returns error of type(s) application/json

{
    "errorMessage": "No such forwarder found.",
    "errorCode": "FIELD_ERROR",
    "errorDetails": {
        "id": "com.vmware.loginsight.api.errors.forwarding.not_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

Operation doesn't return any data structure

500

Internal error while processing the client request

Returns error of type(s) application/json

{
    "errorMessage": "The operation failed due to an internal 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 PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]'

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 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