GET /config/event_sources/event_collectors/{id}

date_range 04-Aug-21

SUMMARY Retrieves an event collector by ID..

Table 1: GET /config/event_sources/event_collectors/{id} resource details:
GET /config/event_sources/event_collectors/{id} resource details
MIME Type
application/json

Table 2: GET /config/event_sources/event_collectors/{id} request parameter details:
GET /config/event_sources/event_collectors/{id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
id	path	Required	Number (Integer)	text/plain	The ID of the event collector to retrieve.
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.

Table 3: GET /config/event_sources/event_collectors/{id} response codes:
GET /config/event_sources/event_collectors/{id} response codes
HTTP Response Code	Unique Code	Description
200		The event collector was retrieved successfully.
404	1002	The event collector ID was not found.
500	1020	An error occurred during the attempt to retrieve the event collector.

Response Description

The event collector after it is retrieved. 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/)..

content_copy zoom_out_map
{
    "component_name": "String",
    "host_id": 42,
    "id": 42,
    "name": "String"
}

Helped me install or use the product
Accelerated my deployment

Discuss the product with a co-worker
Make a purchase inquiry