Skip to content

Latest commit

 

History

History
157 lines (112 loc) · 4.17 KB

FieldSchema.md

File metadata and controls

157 lines (112 loc) · 4.17 KB

Falcon::FieldSchema

All URIs are relative to https://api.us-2.crowdstrike.com

Method HTTP request Description
fdrschema_entities_field_get GET /fdr/entities/schema-fields/v1 Fetch field schema by ID
fdrschema_queries_field_get GET /fdr/queries/schema-fields/v1 Get list of field IDs given a particular query.

fdrschema_entities_field_get

fdrschema_entities_field_get(opts)

Fetch field schema by ID

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::FieldSchema.new
opts = {
  ids: ['inner_example'] # Array<String> | Specify feed IDs to fetch
}

begin
  # Fetch field schema by ID
  result = api_instance.fdrschema_entities_field_get(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling FieldSchema->fdrschema_entities_field_get: #{e}"
end

Using the fdrschema_entities_field_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> fdrschema_entities_field_get_with_http_info(opts)

begin
  # Fetch field schema by ID
  data, status_code, headers = api_instance.fdrschema_entities_field_get_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <SchemaSensorFieldResponseV1>
rescue Falcon::ApiError => e
  puts "Error when calling FieldSchema->fdrschema_entities_field_get_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
ids Array<String> Specify feed IDs to fetch [optional]

Return type

SchemaSensorFieldResponseV1

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

fdrschema_queries_field_get

fdrschema_queries_field_get(opts)

Get list of field IDs given a particular query.

Examples

require 'time'
require 'crimson-falcon'

# Setup authorization
Falcon.configure do |config|
  config.client_id = "Your_Client_ID"
  config.client_secret = "Your_Client_Secret"
  config.cloud = "us-1" # or "us-2", "eu-1", "us-gov1"
end

api_instance = Falcon::FieldSchema.new
opts = {
  limit: 56, # Integer | Limit of the data
  offset: 56, # Integer | Offset into the data
  filter: 'filter_example', # String | FQL filter of the data
  sort: 'sort_example' # String | Sort the data
}

begin
  # Get list of field IDs given a particular query.
  result = api_instance.fdrschema_queries_field_get(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling FieldSchema->fdrschema_queries_field_get: #{e}"
end

Using the fdrschema_queries_field_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> fdrschema_queries_field_get_with_http_info(opts)

begin
  # Get list of field IDs given a particular query.
  data, status_code, headers = api_instance.fdrschema_queries_field_get_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <MsaspecQueryResponse>
rescue Falcon::ApiError => e
  puts "Error when calling FieldSchema->fdrschema_queries_field_get_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
limit Integer Limit of the data [optional]
offset Integer Offset into the data [optional]
filter String FQL filter of the data [optional]
sort String Sort the data [optional]

Return type

MsaspecQueryResponse

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json