ON THIS PAGE
GET /config/event_sources/disconnected_log_collectors
SUMMARY Retrieves a list of disconnected log collectors.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
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. |
sort |
query |
Optional |
String |
text/plain |
Optional - This parameter is used to sort the elements in a list. |
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 collectors were retrieved successfully. |
|
422 |
1001 |
Invalid field. |
422 |
1002 |
Invalid filter. |
422 |
1003 |
Invalid sort criteria. |
422 |
1004 |
Sort not supported on field. |
500 |
1000 |
An error occurred during the attempt to retrieve the disconnected log collectors. |
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" } ]