ON THIS PAGE
GET /config/event_sources/disconnected_log_collectors/{id}
SUMMARY Retrieves an disconnected log collector by ID..
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
id |
path |
Required |
Number (Integer) |
text/plain |
The ID of the disconnected log 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. |
HTTP Response Code | Unique Code | Description |
---|---|---|
200 |
The disconnected log collector was retrieved successfully. |
|
404 |
1001 |
The Disconnected Log Collector was not found. |
500 |
1000 |
An error occurred during the attempt to retrieve the disconnected log collector. |
Response Description
- id - ID - The ID of the disconnected log collector.
- uuid - UUID - The UUID of the disconnected log collector.
- name - String - The name of the Disconnected Log Collector.
- description - String - The description of the Disconnected Log Collector.
- version - String - The version of the Disconnected Log Collector.
- protocol - Enumeration - The transport protocol used by the Disconnected Log Collector to send events to JSA. Possible Values are TLS and UDP.
Response Sample
{ "description": "String", "id": 42, "name": "String", "protocol": "String", "uuid": "String", "version": "String" }