Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

GET /config/event_sources/disconnected_log_collectors/{id}

Retrieves an disconnected log collector by ID..

Table 1: GET /config/event_sources/disconnected_log_collectors/{id} Resource Details

MIME Type

application/json

Table 2: GET /config/event_sources/disconnected_log_collectors/{id} Request Parameter Details

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.

Table 3: GET /config/event_sources/disconnected_log_collectors/{id} Response Codes

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

The disconnected log collector after it is retrieved. A disconnected log collector contains the following fields:

  • 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