Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

POST /config/event_sources/disconnected_log_collectors/{id}

 

Updates a disconnected log collector by ID.

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.

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

MIME Type

application/json

Table 2: POST /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 update.

fields

header

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: POST /config/event_sources/disconnected_log_collectors/{id} Request Body Details

Parameter

Data Type

MIME Type

Description

Sample

log_source_data

Object

application/json

The updated disconnected log collector data. Any field not provided will be ignored.

{ "description": "String", "name": "String", "protocol": "String", "uuid": "String", "version": "String" }

Table 4: POST /config/event_sources/disconnected_log_collectors/{id} Response Codes

HTTP Response Code

Unique Code

Description

200

 

The disconnected log collector was updated successfully.

404

1001

The requested disconnected log collector cannot be found.

409

1002

The 'uuid' parameter must be unique.

409

1005

The 'name' parameter must be unique.

422

1003

The 'uuid' parameter format is invalid.

422

1004

The 'uuid' parameter is required.

422

1006

The 'name' parameter is required.

422

1007

The 'name' parameter must not exceed 255 characters.

422

1008

The 'description' parameter must not exceed 255 characters.

422

1009

The 'version' parameter is required.

422

1010

The 'version' parameter must not exceed 255 characters.

422

1011

The 'protocol' parameter must be TLS or UDP.

500

1100

An error occurred during the attempt to create the disconnected log collector.

Response Description

The updated disconnected log collector identified by the id specified in the request.

Response Sample