Class: Hachi::Clients::Observable

Inherits:
Base
  • Object
show all
Defined in:
lib/hachi/clients/observable.rb

Instance Attribute Summary

Attributes inherited from Base

#api_endpoint, #api_key, #api_version

Instance Method Summary collapse

Methods inherited from Base

#delete, #get, #initialize, #patch, #post

Methods included from Awrence::Methods

#to_camel_keys, #to_camelback_keys

Constructor Details

This class inherits a constructor from Hachi::Clients::Base

Instance Method Details

#create_in_alert(alert_id, **payload) ⇒ Hash

Create an observable in an alert

Parameters:

  • alert_id (String) —

    Observable ID

  • payload (Hash)

Returns:

  • (Hash) 


26
27
28
 
# File 'lib/hachi/clients/observable.rb', line 26

def create_in_alert(alert_id, **payload)
  post("/alert/#{alert_id}/observable", json: payload) { |json| json }
end

#create_in_case(case_id, **payload) ⇒ Hash

Create an observable in a case

Parameters:

  • case_id (String) —

    Observable ID

  • payload (Hash)

Returns:

  • (Hash) 


14
15
16
 
# File 'lib/hachi/clients/observable.rb', line 14

def create_in_case(case_id, **payload)
  post("/case/#{case_id}/observable", json: payload) { |json| json }
end

#delete_by_id(id) ⇒ String

Delete an observable

Parameters:

  • id (String) —

    observable ID

Returns:

  • (String) 


48
49
50
 
# File 'lib/hachi/clients/observable.rb', line 48

def delete_by_id(id)
  delete("/observable/#{id}") { |json| json }
end

#get_by_id(id) ⇒ Hash

Get an observable

Parameters:

  • id (String) —

    observable ID

Returns:

  • (Hash) 


37
38
39
 
# File 'lib/hachi/clients/observable.rb', line 37

def get_by_id(id)
  get("/observable/#{id}") { |json| json }
end