Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

GET /config/event_sources/log_source_management/log_source_types/{id}

Retrieves a log source type by ID. If called by a user/authorized service with System Administrator, Security Admin, or Manage Log Source Types permissions, then all fields will be returned for the log source type. If called by a less privileged client, only name and ID are returned for the log source type.

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

MIME Type

application/json

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

Parameter

Type

Optionality

Data Type

MIME Type

Description

id

path

Required

Number (Integer)

text/plain

The ID of the log source type 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/log_source_management/log_source_types/{id} Response Codes

HTTP Response Code

Unique Code

Description

200

 

The log source type was retrieved successfully.

404

1002

The log source type ID was not found.

500

1020

An error occurred during the attempt to retrieve the log source type.

Response Description

The log source type after it is retrieved. A log source type contains the following fields:

  • id - Integer - The ID of the log source type.

  • name - String - The unique name of the log source type. The name is not localized.

  • internal - Boolean - The condition is set to 'true' if the log source type is an internal log source type (for example, System Notification, SIM Audit, Asset Profiler, and so on) for which log sources cannot be created, edited, or deleted. If this is a user configurable log source type, the condition is set to 'false'.

  • custom - Boolean - The condition is set to 'true' if this is a custom log source type; otherwise, the condition is set to 'false'.

  • protocol_types - Array - The full list of supported protocol types for the log source type. Ensure that every log source type links to at least one protocol type. Each item in this array is a ProtocolMapping structure, defining both the ID of the protocol type and a Boolean that indicates whether the protocol is documented/fully supported for this log source type.

  • default_protocol_id - Long - The ID of the default protocol type for this log source type. The ID must correspond to an existing protocol type. See the Protocol Type API (/api/config/event_sources/log_source_management/protocol_types/).

  • log_source_extension_id - Long - The log source extension that is associated with the log source type. The ID must correspond to an existing log source extension or be set to 'null'. See the Log Source Extension API (/api/config/event_sources/log_source_management/log_source_extensions/).

  • supported_language_ids - Array - The IDs of the languages supported by this log source type. Each ID must correspond to an existing log source language. See the Log Source Language API (/api/config/event_sources/log_source_management/log_source_languages/). All non-custom log source types link to at least one language. Because languages are irrelevant for custom log source types, this field is 'null' for custom types.

  • version - String - The log source type plugin version.

  • latest_version - String - The latest available version of the log source type component.

Response Sample