GET /config/event_sources/event_collectors

Retrieves a list of event collectors..

Table 1. GET /config/event_sources/event_collectors resource details
MIME Type
application/json

Table 2. GET /config/event_sources/event_collectors request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
fields	query	Optional	String	text/plain	Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.
Range	header	Optional	String	text/plain	Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.
filter	query	Optional	String	text/plain	Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.

Table 3. GET /config/event_sources/event_collectors response codes
HTTP Response Code	Unique Code	Description
200		The event collectors were retrieved successfully.
500	1020	An error occurred during the attempt to retrieve the event collectors.

Response Description

The list of all event collectors. A event collector contains the following fields:

id - Long - The ID of the event collector.
name - String - The display name of the event collector. Not localized because it is derived from a process/component name and the hostname of the managed host it runs on, neither of which are translatable.
component_name - String - The name of the component backing this event collector process. Also contained in the 'name' field.
host_id - Long - The ID of the host on which this event collector process runs. See the Hosts API (/api/config/deployment/hosts/)..


[
    {
        "component_name": "String",
        "host_id": 42,
        "id": 42,
        "name": "String"
    }
]