Module: Wazuh::Api::Endpoints::Decoders

Included in:
Wazuh::Api::Endpoints
Defined in:
lib/wazuh/api/endpoints/decoders.rb

Instance Method Summary collapse

Instance Method Details

#all_decoders(options = {}) ⇒ Object

Get all decoders Returns all decoders included in ossec.conf.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :offset (offset) —

    First element to return in the collection.

  • :limit (limit) —

    Maximum number of elements to return.

  • :sort (sort) —

    Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.

  • :search (search) —

    Looks for elements with the specified string.

  • :file (file) —

    Filters by filename.

  • :path (path) —

    Filters by path.

  • :status (status) —

    Filters the decoders by status. Allowed values: enabled, disabled, all

See Also:



25
26
27
 
# File 'lib/wazuh/api/endpoints/decoders.rb', line 25

def all_decoders(options = {})
  get '/decoders', options
end

#all_decoders_files(options = {}) ⇒ Object

Get all decoders files Returns all decoders files included in ossec.conf.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :offset (offset) —

    First element to return in the collection.

  • :limit (limit) —

    Maximum number of elements to return.

  • :sort (sort) —

    Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.

  • :search (search) —

    Looks for elements with the specified string.

  • :file (file) —

    Filters by filename.

  • :path (path) —

    Filters by path.

  • :status (status) —

    Filters the decoders by status. Allowed values: enabled, disabled, all

  • :download (download) —

    Name of the decoder file to download.

See Also:



51
52
53
 
# File 'lib/wazuh/api/endpoints/decoders.rb', line 51

def all_decoders_files(options = {})
  get '/decoders/files', options
end

#all_parent_decoders(options = {}) ⇒ Object

Get all parent decoders Returns all parent decoders included in ossec.conf.

Parameters:

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :offset (offset) —

    First element to return in the collection.

  • :limit (limit) —

    Maximum number of elements to return.

  • :sort (sort) —

    Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.

  • :search (search) —

    Looks for elements with the specified string.

See Also:



67
68
69
 
# File 'lib/wazuh/api/endpoints/decoders.rb', line 67

def all_parent_decoders(options = {})
  get '/decoders/parents', options
end

#decoders_by_name(decoder_name, options = {}) ⇒ Object

Get decoders by name Returns the decoders with the specified name.

Parameters:

  • decoder_name (String) —

    Decoder name

  • options (Hash) (defaults to: {}) —

    a customizable set of options

Options Hash (options):

  • :offset (offset) —

    First element to return in the collection.

  • :limit (limit) —

    Maximum number of elements to return.

  • :sort (sort) —

    Sorts the collection by a field or fields (separated by comma). Use +/- at the beginning to list in ascending or descending order.

  • :search (search) —

    Looks for elements with the specified string.

See Also:



85
86
87
 
# File 'lib/wazuh/api/endpoints/decoders.rb', line 85

def decoders_by_name(decoder_name, options = {})
  get "/decoders/#{decoder_name}", options
end