Module: Wazuh::Api::Endpoints::SecurityConfigurationAssessment

Included in:

Wazuh::Api::Endpoints

Defined in:

lib/wazuh/api/endpoints/security_configuration_assessment.rb

Instance Method Summary

• #checks_sca_database(agent_id, policy_id, options = {}) ⇒ Object

  Get security configuration assessment (SCA) checks database Returns the sca checks of an agent.

• #sca_database(agent_id, options = {}) ⇒ Object

  Get security configuration assessment (SCA) database Returns the sca database of an agent.

Instance Method Details

#checks_sca_database(agent_id, policy_id, options = {}) ⇒ Object

Get security configuration assessment (SCA) checks database Returns the sca checks of an agent.

Parameters:

• agent_id (String) —

  ID to agent

• policy_id (String) —

  ID to policy

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

  a customizable set of options

Options Hash (options):

• :title (title) —

  Filters by title

• :description (description) —

  Filters by policy description

• :rationale (rationale) —

  Filters by rationale

• :remediation (remediation) —

  Filters by remediation

• :file (file) —

  Filters by file

• :process (process) —

  Filters by process

• :directory (directory) —

  Filters by directory

• :registry (registry) —

  Filters by registry

• :references (references) —

  Filters by references

• :result (result) —

  Filters by result

• :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:

• https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-security-configuration-assessment-sca-checks-database

# File 'lib/wazuh/api/endpoints/security_configuration_assessment.rb', line 41

def checks_sca_database(agent_id, policy_id, options = {})
  data = get "/sca/#{agent_id}/checks/#{policy_id}", options
  data.items
end

#sca_database(agent_id, options = {}) ⇒ Object

Get security configuration assessment (SCA) database Returns the sca database of an agent

Parameters:

• agent_id (String) —

  ID to agent

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

  a customizable set of options

Options Hash (options):

• :name (name) —

  Filters by policy name.

• :description (description) —

  Filters by policy description

• :references (references) —

  Filters by references

• :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.

• :q (q) —

  Query to filter results by. This is specially useful to filter by total checks passed, failed or total score (fields pass, fail, score).

See Also:

• https://documentation.wazuh.com/3.10/user-manual/api/reference.html#get-security-configuration-assessment-sca-database

# File 'lib/wazuh/api/endpoints/security_configuration_assessment.rb', line 68

def sca_database(agent_id, options = {})
  data = get "/sca/#{agent_id}", options
  data.items
end