class PassiveTotal::Client::Action

Public Instance Methods

add_tags(query:, tags:) click to toggle source

Adds tags to a given artifact. api.passivetotal.org/api/docs/#api-Actions-PostV2ActionsTags

@param [String] query artifact for which to add tags @param [Array<String>] tags tags to add to artifact

@return [Hash]

# File lib/passivetotal/clients/action.rb, line 15
def add_tags(query:, tags:)
  params = {
    query: query,
    tags: tags,
  }.compact

  _post("/actions/tags", params) { |json| json }
end
bulk_classification(*query) click to toggle source

Retrieve classification statuses for given domains. api.passivetotal.org/api/docs/#api-Actions-GetV2ActionsBulkClassification

@param [Array<String>] query domains for which to retrieve classification statuses

@return [Hash]

# File lib/passivetotal/clients/action.rb, line 50
def bulk_classification(*query)
  params = {
    query: query,
  }.compact

  _get("/actions/bulk/classification", params) { |json| json }
end
classification(query) click to toggle source

Retrieve classification status for a given domain. api.passivetotal.org/api/docs/#api-Actions-GetV2ActionsClassification

@param [String] query domain for which to retrieve classification status

@return [Hash]

# File lib/passivetotal/clients/action.rb, line 66
def classification(query)
  params = {
    query: query,
  }.compact

  _get("/actions/classification", params) { |json| json }
end
delete_tags(query:, tags:) click to toggle source

Removes tags from an artifact. api.passivetotal.org/api/docs/#api-Actions-DeleteV2ActionsTags

@param [String] query artifact from which to remove tags @param [Array<String>] tags tags to remove from artifact

@return [Hash]

# File lib/passivetotal/clients/action.rb, line 33
def delete_tags(query:, tags:)
  params = {
    query: query,
    tags: tags,
  }.compact

  _delete("/actions/tags", params) { |json| json }
end
dynamic_dns(query) click to toggle source

Indicates whether or not a domain's DNS records are updated via dynamic DNS. api.passivetotal.org/api/docs/#api-Actions-GetV2ActionsDynamicDns

@param [String] query domain for which to retrieve dynamic DNS status

@return [Hash]

# File lib/passivetotal/clients/action.rb, line 98
def dynamic_dns(query)
  params = {
    query: query,
  }.compact

  _get("/actions/dynamic-dns", params) { |json| json }
end
ever_compromised(query) click to toggle source

Indicates whether or not a given domain has ever been compromised. api.passivetotal.org/api/docs/#api-Actions-GetV2ActionsEverCompromised

@param [String] query domain to check for compromised status

@return [Hash]

# File lib/passivetotal/clients/action.rb, line 82
def ever_compromised(query)
  params = {
    query: query,
  }.compact

  _get("/actions/ever-compromised", params) { |json| json }
end
monitor(query) click to toggle source

Indicates whether or not a domain is monitored. api.passivetotal.org/api/docs/#api-Actions-GetV2ActionsMonitor

@param [String] query domain for which to check for monitoring

@return [Hash]

# File lib/passivetotal/clients/action.rb, line 114
def monitor(query)
  params = {
    query: query,
  }.compact

  _get("/actions/monitor", params) { |json| json }
end
search_by_tags(query) click to toggle source

Retrieve artifacts for a given tag. api.passivetotal.org/api/docs/#api-Actions-GetV2ActionsTagsSearch

@param [String] query tag for which to retrieve artifacts

@return [Hash]

# File lib/passivetotal/clients/action.rb, line 162
def search_by_tags(query)
  params = {
    query: query,
  }.compact

  _get("/actions/tags/search", params) { |json| json }
end
set_bulk_classification(queries:, classification:) click to toggle source

Set classification statuses for given domains. api.passivetotal.org/api/docs/#api-Actions-PostV2ActionsBulkClassification

@param [Arra<String>] queries domain for which to set classification status @param [String] classification classification status to set for domain

@return [Hash]

# File lib/passivetotal/clients/action.rb, line 179
def set_bulk_classification(queries:, classification:)
  params = {
    queries: queries,
    classification: classification,
  }.compact

  _post("/actions/bulk/classification", params) { |json| json }
end
set_classification(query:, classification:) click to toggle source

Sets the classification status for a given domain. api.passivetotal.org/api/docs/#api-Actions-PostV2ActionsClassification

@param [String] query domain for which to set classification status @param [String] classification classification status to set for domain

@return [Hash]

# File lib/passivetotal/clients/action.rb, line 197
def set_classification(query:, classification:)
  params = {
    query: query,
    classification: classification,
  }.compact

  _post("/actions/classification", params) { |json| json }
end
set_dynamic_dns(query:, status:) click to toggle source

Sets a domain's status to indicate whether or not its DNS records are updated via dynamic DNS. api.passivetotal.org/api/docs/#api-Actions-PostV2ActionsDynamicDns

@param [String] query domain for which to set dynamic DNS status @param [Boolean] status if the domain's DNS records are updated via dynamic DNS

@return [Hash]

# File lib/passivetotal/clients/action.rb, line 233
def set_dynamic_dns(query:, status:)
  params = {
    query: query,
    status: status,
  }.compact

  _post("/actions/dynamic-dns", params) { |json| json }
end
set_ever_compromised(query:, status:) click to toggle source

Sets status for a domain to indicate if it has ever been compromised. api.passivetotal.org/api/docs/#api-Actions-PostV2ActionsEverCompromised

@param [String] query domain for which to set compromised status @param [Boolean] status if the domain has ever been compromised

@return [Hash]

# File lib/passivetotal/clients/action.rb, line 215
def set_ever_compromised(query:, status:)
  params = {
    query: query,
    status: status,
  }.compact

  _post("/actions/ever-compromised", params) { |json| json }
end
set_sinkhole(query:, status:) click to toggle source

Sets status for an IP address to indicate whether or not it is a sinkhole. api.passivetotal.org/api/docs/#api-Actions-PostV2ActionsSinkhole

@param [String] query IP address for which to set sinkhole status @param [Boolean] status if the IP address is a sinkhole

@return [Hash]

# File lib/passivetotal/clients/action.rb, line 251
def set_sinkhole(query:, status:)
  params = {
    query: query,
    status: status,
  }.compact

  _post("/actions/sinkhole", params) { |json| json }
end
set_tags(query:, tags:) click to toggle source

Sets the tags for a given artifact. api.passivetotal.org/api/docs/#api-Actions-PutV2ActionsTags

@param [String] query artifact for which to set tags @param [Array<String>] tags tags to set for artifact

@return [Hash]

# File lib/passivetotal/clients/action.rb, line 269
def set_tags(query:, tags:)
  params = {
    query: query,
    tags: tags,
  }.compact

  _put("/actions/tags", params) { |json| json }
end
sinkhole(query) click to toggle source

Indicates whether or not an IP address is a sinkhole. api.passivetotal.org/api/docs/#api-Actions-GetV2ActionsSinkhole

@param [String] query IP address to check for sinkhole status

@return [Hash]

# File lib/passivetotal/clients/action.rb, line 130
def sinkhole(query)
  params = {
    query: query,
  }.compact

  _get("/actions/sinkhole", params) { |json| json }
end
tags(query) click to toggle source

Retrieves tags for a given artifact. api.passivetotal.org/api/docs/#api-Actions-GetV2ActionsTags

@param [String] query artifact for which to retrieve tags

@return [Hash]

# File lib/passivetotal/clients/action.rb, line 146
def tags(query)
  params = {
    query: query,
  }.compact

  _get("/actions/tags", params) { |json| json }
end