Falcon::ASPM

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

Method	HTTP request	Description
create_executor_node	POST /aspm-api-gateway/api/v1/executor_nodes	Create a new relay node
create_integration	POST /aspm-api-gateway/api/v1/integrations	Create a new integration
create_integration_task	POST /aspm-api-gateway/api/v1/integration_tasks	Create new integration task.
delete_executor_node	DELETE /aspm-api-gateway/api/v1/executor_nodes/{ID}	Delete a relay node
delete_integration	DELETE /aspm-api-gateway/api/v1/integrations/{ID}	Delete an existing integration by its ID
delete_integration_task	DELETE /aspm-api-gateway/api/v1/integration_tasks/{ID}	Delete an existing integration task by its ID
delete_tags	POST /aspm-api-gateway/api/v1/tags	Remove existing tags
execute_query	POST /aspm-api-gateway/api/v1/query	Execute a query. The syntax used is identical to that of the query page.
get_executor_nodes	GET /aspm-api-gateway/api/v1/executor_nodes	Get all the relay nodes
get_executor_nodes_metadata	GET /aspm-api-gateway/api/v1/executor_nodes/metadata	Get metadata about all executor nodes
get_integration_tasks	GET /aspm-api-gateway/api/v1/integration_tasks	Get all the integration tasks
get_integration_tasks_metadata	GET /aspm-api-gateway/api/v1/integration_tasks/metadata	Get metadata about all integration tasks
get_integration_types	GET /aspm-api-gateway/api/v1/integration_types	Get all the integration types
get_integrations	GET /aspm-api-gateway/api/v1/integrations	Get a list of all the integrations
get_service_violation_types	GET /aspm-api-gateway/api/v1/services/violations/types	Get the different types of violation
get_services_count	POST /aspm-api-gateway/api/v1/services/count	Get the total amount of existing services
get_tags	GET /aspm-api-gateway/api/v1/tags	Get all the tags
run_integration_task	POST /aspm-api-gateway/api/v1/integration_tasks/{ID}/run	Run an integration task by its ID
service_now_get_deployments	GET /aspm-api-gateway/api/v1/servicenow/deployments
service_now_get_services	GET /aspm-api-gateway/api/v1/servicenow/services
update_executor_node	PUT /aspm-api-gateway/api/v1/executor_nodes	Update an existing relay node
update_integration	PUT /aspm-api-gateway/api/v1/integrations/{ID}	Update an existing integration by its ID
update_integration_task	PUT /aspm-api-gateway/api/v1/integration_tasks/{ID}	Update an existing integration task by its ID
upsert_business_applications	PUT /aspm-api-gateway/api/v1/business_applications	Create or Update Business Applications
upsert_tags	PUT /aspm-api-gateway/api/v1/tags	Create new or update existing tag. You can update unique tags table or regular tags table

create_executor_node

create_executor_node(body)

Create a new relay node

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::ASPM.new
body = Falcon::TypesExecutorNode.new # TypesExecutorNode | 

begin
  # Create a new relay node
  result = api_instance.create_executor_node(body)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->create_executor_node: #{e}"
end

Using the create_executor_node_with_http_info variant

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

<Array(, Integer, Hash)> create_executor_node_with_http_info(body)

begin
  # Create a new relay node
  data, status_code, headers = api_instance.create_executor_node_with_http_info(body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <TypesExecutorNode>
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->create_executor_node_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
body	TypesExecutorNode

Return type

TypesExecutorNode

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

create_integration

create_integration(body)

Create a new integration

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::ASPM.new
body = Falcon::TypesCreateIntegrationRequest.new # TypesCreateIntegrationRequest | 

begin
  # Create a new integration
  result = api_instance.create_integration(body)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->create_integration: #{e}"
end

Using the create_integration_with_http_info variant

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

<Array(, Integer, Hash)> create_integration_with_http_info(body)

begin
  # Create a new integration
  data, status_code, headers = api_instance.create_integration_with_http_info(body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <TypesIntegrationResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->create_integration_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
body	TypesCreateIntegrationRequest

Return type

TypesIntegrationResponse

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

create_integration_task

create_integration_task(body)

Create new integration task.

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::ASPM.new
body = Falcon::TypesCreateIntegrationTaskRequest.new # TypesCreateIntegrationTaskRequest | 

begin
  # Create new integration task.
  result = api_instance.create_integration_task(body)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->create_integration_task: #{e}"
end

Using the create_integration_task_with_http_info variant

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

<Array(, Integer, Hash)> create_integration_task_with_http_info(body)

begin
  # Create new integration task.
  data, status_code, headers = api_instance.create_integration_task_with_http_info(body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <TypesIntegrationTaskResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->create_integration_task_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
body	TypesCreateIntegrationTaskRequest

Return type

TypesIntegrationTaskResponse

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

delete_executor_node

delete_executor_node(id)

Delete a relay node

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::ASPM.new
id = 56 # Integer | 

begin
  # Delete a relay node
  api_instance.delete_executor_node(id)
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->delete_executor_node: #{e}"
end

Using the delete_executor_node_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> delete_executor_node_with_http_info(id)

begin
  # Delete a relay node
  data, status_code, headers = api_instance.delete_executor_node_with_http_info(id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->delete_executor_node_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer

Return type

nil (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

delete_integration

delete_integration(id)

Delete an existing integration by its 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::ASPM.new
id = 56 # Integer | 

begin
  # Delete an existing integration by its ID
  api_instance.delete_integration(id)
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->delete_integration: #{e}"
end

Using the delete_integration_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> delete_integration_with_http_info(id)

begin
  # Delete an existing integration by its ID
  data, status_code, headers = api_instance.delete_integration_with_http_info(id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->delete_integration_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer

Return type

nil (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

delete_integration_task

delete_integration_task(id)

Delete an existing integration task by its 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::ASPM.new
id = 56 # Integer | 

begin
  # Delete an existing integration task by its ID
  api_instance.delete_integration_task(id)
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->delete_integration_task: #{e}"
end

Using the delete_integration_task_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> delete_integration_task_with_http_info(id)

begin
  # Delete an existing integration task by its ID
  data, status_code, headers = api_instance.delete_integration_task_with_http_info(id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->delete_integration_task_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer

Return type

nil (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

delete_tags

delete_tags(body)

Remove existing tags

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::ASPM.new
body = Falcon::TypesEditTagRequest.new({entries: [Falcon::TypesTagEntry.new({persistent_signature: 'persistent_signature_example'})], name: 'name_example'}) # TypesEditTagRequest | 

begin
  # Remove existing tags
  api_instance.delete_tags(body)
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->delete_tags: #{e}"
end

Using the delete_tags_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> delete_tags_with_http_info(body)

begin
  # Remove existing tags
  data, status_code, headers = api_instance.delete_tags_with_http_info(body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->delete_tags_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
body	TypesEditTagRequest

Return type

nil (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

execute_query

execute_query(body)

Execute a query. The syntax used is identical to that of the query page.

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::ASPM.new
body = Falcon::TypesQueryRequest.new({query: 'query_example'}) # TypesQueryRequest |  **params details:** - selectFields: - **fields** - For filtering relevant fields only. - **withoutServices** - Default is set to **true**, you will not receive information about the services. If you want to get the relevant service, set to **false**. - **serviceFields**-  For filtering relevant fields of the service (if you chose to get it)

begin
  # Execute a query. The syntax used is identical to that of the query page.
  result = api_instance.execute_query(body)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->execute_query: #{e}"
end

Using the execute_query_with_http_info variant

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

<Array(, Integer, Hash)> execute_query_with_http_info(body)

begin
  # Execute a query. The syntax used is identical to that of the query page.
  data, status_code, headers = api_instance.execute_query_with_http_info(body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <TypesQueryResult>
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->execute_query_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
body	TypesQueryRequest	params details: - selectFields: - fields - For filtering relevant fields only. - withoutServices - Default is set to true, you will not receive information about the services. If you want to get the relevant service, set to false. - serviceFields- For filtering relevant fields of the service (if you chose to get it)

Return type

TypesQueryResult

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

get_executor_nodes

get_executor_nodes(node_type, opts)

Get all the relay nodes

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::ASPM.new
node_type = 'node_type_example' # String | 
opts = {
  integration_type: 56, # Integer | 
  offset: 56, # Integer | 
  limit: 56, # Integer | 
  order_by: 'name', # String | 
  direction: 'asc', # String | 
  executor_node_ids: ['inner_example'], # Array<String> | executor node ids
  executor_node_names: ['inner_example'], # Array<String> | executor node names
  executor_node_states: [37], # Array<Integer> | executor node states
  executor_node_types: ['inner_example'] # Array<String> | executor node types
}

begin
  # Get all the relay nodes
  result = api_instance.get_executor_nodes(node_type, opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->get_executor_nodes: #{e}"
end

Using the get_executor_nodes_with_http_info variant

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

<Array(, Integer, Hash)> get_executor_nodes_with_http_info(node_type, opts)

begin
  # Get all the relay nodes
  data, status_code, headers = api_instance.get_executor_nodes_with_http_info(node_type, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <TypesListExecutorNodesResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->get_executor_nodes_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
node_type	String
integration_type	Integer		[optional]
offset	Integer		[optional]
limit	Integer		[optional]
order_by	String		[optional]
direction	String		[optional]
executor_node_ids	Array<String>	executor node ids	[optional]
executor_node_names	Array<String>	executor node names	[optional]
executor_node_states	Array<Integer>	executor node states	[optional]
executor_node_types	Array<String>	executor node types	[optional]

Return type

TypesListExecutorNodesResponse

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_executor_nodes_metadata

get_executor_nodes_metadata(opts)

Get metadata about all executor nodes

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::ASPM.new
opts = {
  executor_node_ids: ['inner_example'], # Array<String> | executor node ids
  executor_node_names: ['inner_example'], # Array<String> | executor node names
  executor_node_states: [37], # Array<Integer> | executor node states
  executor_node_types: ['inner_example'] # Array<String> | executor node types
}

begin
  # Get metadata about all executor nodes
  result = api_instance.get_executor_nodes_metadata(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->get_executor_nodes_metadata: #{e}"
end

Using the get_executor_nodes_metadata_with_http_info variant

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

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

begin
  # Get metadata about all executor nodes
  data, status_code, headers = api_instance.get_executor_nodes_metadata_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <TypesGetExecutorNodesMetadataResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->get_executor_nodes_metadata_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
executor_node_ids	Array<String>	executor node ids	[optional]
executor_node_names	Array<String>	executor node names	[optional]
executor_node_states	Array<Integer>	executor node states	[optional]
executor_node_types	Array<String>	executor node types	[optional]

Return type

TypesGetExecutorNodesMetadataResponse

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_integration_tasks

get_integration_tasks(opts)

Get all the integration tasks

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::ASPM.new
opts = {
  integration_task_type: 56, # Integer | 
  category: 'category_example', # String | 
  offset: 56, # Integer | 
  limit: 56, # Integer | 
  order_by: 'name', # String | 
  direction: 'asc', # String | 
  integration_task_types: 56, # Integer | 
  ids: 56, # Integer | 
  names: 'names_example' # String | 
}

begin
  # Get all the integration tasks
  result = api_instance.get_integration_tasks(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->get_integration_tasks: #{e}"
end

Using the get_integration_tasks_with_http_info variant

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

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

begin
  # Get all the integration tasks
  data, status_code, headers = api_instance.get_integration_tasks_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <TypesListIntegrationTasksResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->get_integration_tasks_with_http_info: #{e}"
end

Parameters

Name	Type	Notes
integration_task_type	Integer	[optional]
category	String	[optional]
offset	Integer	[optional]
limit	Integer	[optional]
order_by	String	[optional]
direction	String	[optional]
integration_task_types	Integer	[optional]
ids	Integer	[optional]
names	String	[optional]

Return type

TypesListIntegrationTasksResponse

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_integration_tasks_metadata

get_integration_tasks_metadata(opts)

Get metadata about all integration tasks

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::ASPM.new
opts = {
  category: 'collecting', # String | 
  integration_task_types: 56, # Integer | 
  ids: 56, # Integer | 
  names: 'names_example' # String | 
}

begin
  # Get metadata about all integration tasks
  result = api_instance.get_integration_tasks_metadata(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->get_integration_tasks_metadata: #{e}"
end

Using the get_integration_tasks_metadata_with_http_info variant

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

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

begin
  # Get metadata about all integration tasks
  data, status_code, headers = api_instance.get_integration_tasks_metadata_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <TypesGetIntegrationTasksMetadataResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->get_integration_tasks_metadata_with_http_info: #{e}"
end

Parameters

Name	Type	Notes
category	String	[optional]
integration_task_types	Integer	[optional]
ids	Integer	[optional]
names	String	[optional]

Return type

TypesGetIntegrationTasksMetadataResponse

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_integration_types

get_integration_types

Get all the integration types

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::ASPM.new

begin
  # Get all the integration types
  result = api_instance.get_integration_types
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->get_integration_types: #{e}"
end

Using the get_integration_types_with_http_info variant

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

<Array(, Integer, Hash)> get_integration_types_with_http_info

begin
  # Get all the integration types
  data, status_code, headers = api_instance.get_integration_types_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <TypesListIntegrationTypesResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->get_integration_types_with_http_info: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

TypesListIntegrationTypesResponse

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_integrations

get_integrations(opts)

Get a list of all the integrations

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::ASPM.new
opts = {
  integration_type: 56, # Integer | 
  category: 'category_example' # String | 
}

begin
  # Get a list of all the integrations
  result = api_instance.get_integrations(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->get_integrations: #{e}"
end

Using the get_integrations_with_http_info variant

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

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

begin
  # Get a list of all the integrations
  data, status_code, headers = api_instance.get_integrations_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <TypesListIntegrationsResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->get_integrations_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
integration_type	Integer		[optional]
category	String		[optional]

Return type

TypesListIntegrationsResponse

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

get_service_violation_types

get_service_violation_types(body)

Get the different types of violation

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::ASPM.new
body = Falcon::TypesGenericUserFacingRequest.new # TypesGenericUserFacingRequest | 

begin
  # Get the different types of violation
  result = api_instance.get_service_violation_types(body)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->get_service_violation_types: #{e}"
end

Using the get_service_violation_types_with_http_info variant

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

<Array(, Integer, Hash)> get_service_violation_types_with_http_info(body)

begin
  # Get the different types of violation
  data, status_code, headers = api_instance.get_service_violation_types_with_http_info(body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <TypesGetViolationTypesResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->get_service_violation_types_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
body	TypesGenericUserFacingRequest

Return type

TypesGetViolationTypesResponse

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

get_services_count

get_services_count(body)

Get the total amount of existing services

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::ASPM.new
body = Falcon::TypesGetServicesRequest.new # TypesGetServicesRequest | 

begin
  # Get the total amount of existing services
  api_instance.get_services_count(body)
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->get_services_count: #{e}"
end

Using the get_services_count_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> get_services_count_with_http_info(body)

begin
  # Get the total amount of existing services
  data, status_code, headers = api_instance.get_services_count_with_http_info(body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->get_services_count_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
body	TypesGetServicesRequest

Return type

nil (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

get_tags

get_tags(opts)

Get all the tags

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::ASPM.new
opts = {
  is_unique: true, # Boolean | 
  tag_name: 'tag_name_example', # String | 
  limit: 56, # Integer | 
  offset: 56, # Integer | 
  name: ['inner_example'] # Array<String> | 
}

begin
  # Get all the tags
  result = api_instance.get_tags(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->get_tags: #{e}"
end

Using the get_tags_with_http_info variant

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

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

begin
  # Get all the tags
  data, status_code, headers = api_instance.get_tags_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <TypesTagsDataResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->get_tags_with_http_info: #{e}"
end

Parameters

Name	Type	Notes
is_unique	Boolean	[optional]
tag_name	String	[optional]
limit	Integer	[optional]
offset	Integer	[optional]
name	Array<String>	[optional]

Return type

TypesTagsDataResponse

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

run_integration_task

run_integration_task(id, body, opts)

Run an integration task by its 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::ASPM.new
id = 56 # Integer | 
body = Falcon::TypesRunIntegrationTaskRequest.new # TypesRunIntegrationTaskRequest | 
opts = {
  category: 'category_example' # String | 
}

begin
  # Run an integration task by its ID
  result = api_instance.run_integration_task(id, body, opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->run_integration_task: #{e}"
end

Using the run_integration_task_with_http_info variant

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

<Array(, Integer, Hash)> run_integration_task_with_http_info(id, body, opts)

begin
  # Run an integration task by its ID
  data, status_code, headers = api_instance.run_integration_task_with_http_info(id, body, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <TypesIntegrationTaskTestConnectionResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->run_integration_task_with_http_info: #{e}"
end

Parameters

Name	Type	Notes
id	Integer
body	TypesRunIntegrationTaskRequest
category	String	[optional]

Return type

TypesIntegrationTaskTestConnectionResponse

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

service_now_get_deployments

service_now_get_deployments(opts)

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::ASPM.new
opts = {
  ql_filters: 'ql_filters_example', # String | 
  limit: 56, # Integer | 
  offset: 56, # Integer | 
  order_by: 'order_by_example', # String | 
  direction: 'direction_example' # String | 
}

begin
  
  result = api_instance.service_now_get_deployments(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->service_now_get_deployments: #{e}"
end

Using the service_now_get_deployments_with_http_info variant

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

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

begin
  
  data, status_code, headers = api_instance.service_now_get_deployments_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <TypesServiceNowDeploymentsResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->service_now_get_deployments_with_http_info: #{e}"
end

Parameters

Name	Type	Notes
ql_filters	String	[optional]
limit	Integer	[optional]
offset	Integer	[optional]
order_by	String	[optional]
direction	String	[optional]

Return type

TypesServiceNowDeploymentsResponse

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

service_now_get_services

service_now_get_services(opts)

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::ASPM.new
opts = {
  ql_filters: 'ql_filters_example', # String | 
  limit: 56, # Integer | 
  offset: 56, # Integer | 
  order_by: 'order_by_example', # String | 
  direction: 'direction_example' # String | 
}

begin
  
  result = api_instance.service_now_get_services(opts)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->service_now_get_services: #{e}"
end

Using the service_now_get_services_with_http_info variant

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

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

begin
  
  data, status_code, headers = api_instance.service_now_get_services_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <TypesServiceNowServicesResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->service_now_get_services_with_http_info: #{e}"
end

Parameters

Name	Type	Notes
ql_filters	String	[optional]
limit	Integer	[optional]
offset	Integer	[optional]
order_by	String	[optional]
direction	String	[optional]

Return type

TypesServiceNowServicesResponse

Authorization

oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

update_executor_node

update_executor_node(body)

Update an existing relay node

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::ASPM.new
body = Falcon::TypesExecutorNode.new # TypesExecutorNode | 

begin
  # Update an existing relay node
  result = api_instance.update_executor_node(body)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->update_executor_node: #{e}"
end

Using the update_executor_node_with_http_info variant

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

<Array(, Integer, Hash)> update_executor_node_with_http_info(body)

begin
  # Update an existing relay node
  data, status_code, headers = api_instance.update_executor_node_with_http_info(body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <TypesExecutorNode>
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->update_executor_node_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
body	TypesExecutorNode

Return type

TypesExecutorNode

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

update_integration

update_integration(id, body)

Update an existing integration by its 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::ASPM.new
id = 56 # Integer | 
body = Falcon::TypesUpdateIntegrationRequest.new # TypesUpdateIntegrationRequest | 

begin
  # Update an existing integration by its ID
  result = api_instance.update_integration(id, body)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->update_integration: #{e}"
end

Using the update_integration_with_http_info variant

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

<Array(, Integer, Hash)> update_integration_with_http_info(id, body)

begin
  # Update an existing integration by its ID
  data, status_code, headers = api_instance.update_integration_with_http_info(id, body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <TypesIntegrationResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->update_integration_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer
body	TypesUpdateIntegrationRequest

Return type

TypesIntegrationResponse

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

update_integration_task

update_integration_task(id, body)

Update an existing integration task by its 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::ASPM.new
id = 56 # Integer | 
body = Falcon::TypesUpdateIntegrationTaskRequest.new # TypesUpdateIntegrationTaskRequest | 

begin
  # Update an existing integration task by its ID
  result = api_instance.update_integration_task(id, body)
  p result
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->update_integration_task: #{e}"
end

Using the update_integration_task_with_http_info variant

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

<Array(, Integer, Hash)> update_integration_task_with_http_info(id, body)

begin
  # Update an existing integration task by its ID
  data, status_code, headers = api_instance.update_integration_task_with_http_info(id, body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <TypesIntegrationTaskResponse>
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->update_integration_task_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
id	Integer
body	TypesUpdateIntegrationTaskRequest

Return type

TypesIntegrationTaskResponse

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

upsert_business_applications

upsert_business_applications(body)

Create or Update Business Applications

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::ASPM.new
body = Falcon::TypesUpsertBusinessApplicationRequest.new({name: 'name_example', persistent_signatures: ['persistent_signatures_example']}) # TypesUpsertBusinessApplicationRequest | 

begin
  # Create or Update Business Applications
  api_instance.upsert_business_applications(body)
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->upsert_business_applications: #{e}"
end

Using the upsert_business_applications_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> upsert_business_applications_with_http_info(body)

begin
  # Create or Update Business Applications
  data, status_code, headers = api_instance.upsert_business_applications_with_http_info(body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->upsert_business_applications_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
body	TypesUpsertBusinessApplicationRequest

Return type

nil (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

upsert_tags

upsert_tags(body)

Create new or update existing tag. You can update unique tags table or regular tags table

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::ASPM.new
body = Falcon::TypesEditUniqueTagRequest.new({entries: [Falcon::TypesUniqueTagEntry.new]}) # TypesEditUniqueTagRequest | 

begin
  # Create new or update existing tag. You can update unique tags table or regular tags table
  api_instance.upsert_tags(body)
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->upsert_tags: #{e}"
end

Using the upsert_tags_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> upsert_tags_with_http_info(body)

begin
  # Create new or update existing tag. You can update unique tags table or regular tags table
  data, status_code, headers = api_instance.upsert_tags_with_http_info(body)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue Falcon::ApiError => e
  puts "Error when calling ASPM->upsert_tags_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
body	TypesEditUniqueTagRequest

Return type

nil (empty response body)

Authorization

oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

Files

ASPM.md

Latest commit

History

ASPM.md

File metadata and controls

Falcon::ASPM

create_executor_node

Examples

Using the create_executor_node_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

create_integration

Examples

Using the create_integration_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

create_integration_task

Examples

Using the create_integration_task_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

delete_executor_node

Examples

Using the delete_executor_node_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

delete_integration

Examples

Using the delete_integration_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

delete_integration_task

Examples

Using the delete_integration_task_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

delete_tags

Examples

Using the delete_tags_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

execute_query

Examples

Using the execute_query_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_executor_nodes

Examples

Using the get_executor_nodes_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_executor_nodes_metadata

Examples

Using the get_executor_nodes_metadata_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

get_integration_tasks

Examples

Using the get_integration_tasks_with_http_info variant