GET Log Forwarder Id

Retrieves the details for the specified forwarding configuration.

Request

URI

GET

https://{api_host}/api/v1/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/v1/log-forwarder/] API.

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.

Bearer

Responses

200

The forwarding configuration details were retrieved successfully.

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

{
    "acceptCert": false,
    "name": "test1",
    "host": "10.10.10.10",
    "port": 9000,
    "protocol": "cfapi",
    "sslEnabled": false,
    "workerCount": 8,
    "diskCacheSize": 104857600,
    "tags": {},
    "filter": "",
    "forwardComplementaryFields": true,
    "id": "5a105e8b-9d40-3132-9780-d62ea2265d8a",
    "forwarderStats": {
        "state": "ACTIVE",
        "rate": 1.4,
        "logsForwarded": 84,
        "logsDropped": 0
    }
}

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"

404

Unable to find the specified log forwarding configuration.

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.

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.

440

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

"Login Timeout"

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 -H 'Authorization: <value>' https://{api_host}/api/v1/log-forwarder/{id}

On This Page

Description

Request

Path Parameters

Query Parameters

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