By using the API or HTTP requests, you can set and get the forwarding configuration, check the connection with the remote server or servers, and exchange test messages with them.

The following HTTP requests show the syntax that you can use to perform the available user operations.

Note: When you send the requests, you must authenticate with vCenter Server root credentials. 
GET https://<vcenter_ip_address_or_fqdn>:5480/rest/appliance/logging/forwarding
POST https://<vcenter_ip_address_or_fqdn>:5480/rest/appliance/logging/forwarding?action=test
PUT https://<vcenter_ip_address_or_fqdn>:5480/rest/appliance/logging/forwarding

For information about the body of each HTTP request, see the REST API Reference documentation.

Table 1. HTTP Status Codes

HTTP Status Code

Description

Operations That Return the Status Code

200

The operation is successful.

All available operations. You can check the returned data in the results data structure.

400

You use an invalid argument. For example, a protocol that it is not supported, invalid port number, or the number of configurations is greater than 3.

Set forwarding configuration.

401

You use invalid user name or password, or authentication is failed.

All available operations.

500

There is a vapi std error. For information about the types of vapi std errors, see the vapi.std.errors API in the API reference documentation.

Set forwarding configuration.