Get All Log Forwarders

Get All Log Forwarders
Get all log forwarders

Get all log forwarders

Request
URI
GET
https://{api_host}/api/v2/logs/forwarders
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

Log-forwarders retrieved successfully

[
    {
        "certificate": "string",
        "connectionRefreshInterval": 0,
        "constraints": {
            "bool": {
                "filter": [
                    "Query Object"
                ],
                "must": [
                    "Query Object"
                ],
                "must_not": [
                    "Query Object"
                ],
                "should": [
                    "Query Object"
                ]
            },
            "exists": {
                "field": "string"
            },
            "match_all": {},
            "match_phrase": {
                "empty": false
            },
            "prefix": {
                "empty": false
            },
            "range": {
                "empty": false
            },
            "regexp": {
                "empty": false
            },
            "term": {
                "empty": false
            },
            "terms": {
                "empty": false
            }
        },
        "enabled": false,
        "forwardComplementaryFields": false,
        "host": "string",
        "id": "string",
        "name": "string",
        "port": 0,
        "protocol": "string",
        "sslEnabled": false,
        "tags": {
            "tags": "string"
        },
        "transportProtocol": "string",
        "workerCount": 0
    }
]
array of object
Optional

403

Forbidden: Authentication required

Returns ErrorBody of type(s) application/json 
{
    "errorCode": "string",
    "errorDetails": {},
    "errorMessage": "string"
}
string
errorCode
Optional

errorCode

Possible values are : API_ERROR, 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, AUTH_PROVIDER_ERROR, SECURITY_ERROR, DEPLOYMENT_ERROR, SUPPORT_BUNDLE_ERROR, VIP_ERROR, LOAD_BALANCER_ERROR, VIDM_ERROR, VIDB_ERROR, AD_ERROR, WEBHOOK_ERROR, WEB_PROXY_ERROR, SMTP_ERROR, QUERY_ERROR, CERTIFICATE_PEM_FORMAT_ERROR, CERTIFICATE_FILE_INVALID, CERTIFICATE_UPDATE_ERROR, NSX_INTEGRATION_ERROR, NSX_MANAGER_CONNECTIVITY_ERROR, NO_CONFIGURATION_ERROR, SSL_ERROR, CERTIFICATE_PURPOSE_ERROR, VCF_CAPABILITIES_REGISTRY_ERROR, VALIDATION_ERROR, INTERNAL_SERVER_ERROR, UNPROCESSABLE_ENTITY, RESOURCE_EXHAUSTED,
object
errorDetails
Optional

errorDetails

string
errorMessage
Optional

errorMessage


500

Internal server error

Returns ErrorBody of type(s) application/json 
{
    "errorCode": "string",
    "errorDetails": {},
    "errorMessage": "string"
}
string
errorCode
Optional

errorCode

Possible values are : API_ERROR, 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, AUTH_PROVIDER_ERROR, SECURITY_ERROR, DEPLOYMENT_ERROR, SUPPORT_BUNDLE_ERROR, VIP_ERROR, LOAD_BALANCER_ERROR, VIDM_ERROR, VIDB_ERROR, AD_ERROR, WEBHOOK_ERROR, WEB_PROXY_ERROR, SMTP_ERROR, QUERY_ERROR, CERTIFICATE_PEM_FORMAT_ERROR, CERTIFICATE_FILE_INVALID, CERTIFICATE_UPDATE_ERROR, NSX_INTEGRATION_ERROR, NSX_MANAGER_CONNECTIVITY_ERROR, NO_CONFIGURATION_ERROR, SSL_ERROR, CERTIFICATE_PURPOSE_ERROR, VCF_CAPABILITIES_REGISTRY_ERROR, VALIDATION_ERROR, INTERNAL_SERVER_ERROR, UNPROCESSABLE_ENTITY, RESOURCE_EXHAUSTED,
object
errorDetails
Optional

errorDetails

string
errorMessage
Optional

errorMessage


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v2/logs/forwarders
On This Page
Log Forwarder Operations
GET
Get All Log Forwarders
POST
Create Log Forwarder
POST
Test Log Forwarder Connection
DELETE
Delete Log Forwarder
GET
Get Log Forwarder By Id
PATCH
Patch Log Forwarder
PUT
Update Log Forwarder