Create a new Site Collector instance

post

https://api.us-west.exabeam.cloud/site-collectors/v1/cores

Create a new Site Collector instance and create a new Site Collector Core on your VM. After you create a Site Collector Core, use the POST installation-command endpoint to retrieve the installation command required to install a Site Collector instance for the given Core ID.

Body Params

name

string

required

length between 2 and 50

Name of the new Site Collector instance.

deploymentHosts

array of strings

required

Hostname or IP address of the VM on which you want to install the Site Collector Core. List of hosts is reserved for future clustered installations. A single value in the list is required for example, vm-sc-core-1.

deploymentHosts*

egressFilter

object

An array which contains arrays with allow and deny conditions to apply to any ingested log data.

proxy

object

A set of properties that describe proxy configuration through which Site Collector Core connects to the Exabeam Security Operations Platform.

metadata

object

A set of properties that add additional context to the log messages for the Site Collector Core before the log messages reach the Exabeam Security Operations Platform.

installationPath

string

Enter the path of the custom Installation folder that you created for Site Collector Core installation, operations, and upgrade. The default path for the Installation folder is /opt.

extractionPath

string

Specify the custom directory path for downloading temporary files generated during the Site Collector Core package extraction and installation process. By default, extracted files are downloaded to the /tmp directory.

Responses

Language

Credentials

OAuth2

URL

Request

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Bad Request

401Unauthorized

403Permission Denied

406Not Acceptable

500Internal Server Error