DELETE Log Forwarder Id

DELETE Log Forwarder Id

Deletes an log forwarding destination.

Request
URI
DELETE
https://{api_host}/api/v1/log-forwarder/{id}
COPY
Path Parameters
string
id
Required

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

Authentication
This operation uses the following authentication methods.
Responses
200

Log forwarding configuration removed successfully

Operation doesn't return any data structure

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

Log forwarding configuration is not found

Operation doesn't return any data structure

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.

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.


Code Samples
COPY
                    curl -X DELETE -H 'Authorization: <value>' https://{api_host}/api/v1/log-forwarder/{id}
On This Page
Log Forwarder Operations
GET
GET Log Forwarder
POST
POST Log Forwarder
GET
GET Log Forwarder Id
PUT
PUT Log Forwarder Id
DELETE
DELETE Log Forwarder Id
PATCH
PATCH Log Forwarder Id
POST
POST Log Forwarder Testconnection
POST
POST Log Forwarder Batch