POST Log Forwarder Batch

Adds a log forwarding destination.

Request

URI

POST

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

COPY

Request Body

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

Optional

{
    "forwarders": [
        {
            "acceptCert": false,
            "name": "test1",
            "host": "10.10.10.10",
            "port": 9000,
            "protocol": "cfapi",
            "sslEnabled": false,
            "workerCount": 8,
            "diskCacheSize": 104857600,
            "tags": {},
            "filter": "",
            "forwardComplementaryFields": true
        },
        {
            "acceptCert": false,
            "name": "test2",
            "host": "10.10.10.10",
            "port": 1514,
            "protocol": "syslog",
            "sslEnabled": true,
            "workerCount": 12,
            "diskCacheSize": 104857600,
            "tags": {},
            "filter": "",
            "transportProtocol": "tcp",
            "forwardComplementaryFields": false
        }
    ]
}

Authentication

This operation uses the following authentication methods.

Bearer

Responses

201

Successfully added log forwarder configuration.

Operation doesn't return any data structure

207

Partial success - not all configurations are added successfully

{
    "multiStatus": [
        {
            "configName": "test 1",
            "status": 409,
            "info": "Forwarder with specified name already exists."
        },
        {
            "configName": "test 2",
            "status": 201
        },
        {
            "configName": "test 3",
            "status": 400,
            "info": "more than 10 configs are not supported"
        },
        {
            "configName": "test 4",
            "status": 400,
            "info": "more than 10 configs are not supported"
        }
    ]
}

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 -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/api/v1/log-forwarder/batch

On This Page

Description

Request

Request Body

Authentication

Response

201 Response Body

207 Response Body

Errors

Log Forwarder Operations

GET

GET Log Forwarder