Skip to content

About

No description, website, or topics provided.

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

 
 

Repository files navigation

HTTP

Publisher: Splunk
Connector Version: 3.5.0
Product Vendor: Generic
Product Name: HTTP
Product Version Supported (regex): ".*"
Minimum Product Version: 5.1.0

This App facilitates making HTTP requests as actions

For security reasons, accessing 127.0.0.1 is not allowed.

This app requires access to port 80(for request send over HTTP) or port 443(for request send over HTTPS) on your Phantom host(s) in order to function.

Authentication is carried out in following priority order

  1. Basic Auth (username and password)
  2. OAuth (oauth token url, client id and client secret)
  3. Provided Auth token (auth_token_name, auth_token)

Configuration Variables

The below configuration variables are required for this Connector to operate. These variables are specified when configuring a HTTP asset in SOAR.

VARIABLE REQUIRED TYPE DESCRIPTION
base_url required string Base URL for making queries. (e.g. https://myservice/)
test_path optional string Endpoint for test connectivity. (e.g. /some/specific/endpoint , appended to Base URL)
auth_token_name optional string Type of authentication token
auth_token optional password Value of authentication token
username optional string Username (for HTTP basic auth)
password optional password Password (for HTTP basic auth)
oauth_token_url optional string URL to fetch oauth token from
placeholder optional ph
client_id optional string Client ID (for OAuth)
client_secret optional password Client Secret (for OAuth)
timeout optional numeric Timeout for HTTP calls
test_http_method optional string HTTP Method for Test Connectivity

Supported Actions

test connectivity - Validate connection using the configured credentials
put data - Perform a REST PUT call to the server
patch data - Perform a REST PATCH call to the server
delete data - Perform a REST DELETE call to the server
get headers - Perform a REST HEAD call to the server
get options - Perform a REST OPTIONS call to the server
get data - Perform a REST GET call to the server
post data - Perform a REST POST call to the server
get file - Retrieve a file from the endpoint and save it to the vault
put file - Put a file from the vault to another location

action: 'test connectivity'

Validate connection using the configured credentials

Type: test
Read only: True

This action will perform a GET on the configured base_url. The action will succeed if given a status code between 200 and 399 (inclusive). Therefore, if the given base URL requires no authentication, this action may pass even if the supplied credentials are incorrect. Alternately, if the given base URL does not point to a valid endpoint, this action could fail even if other actions may succeed with valid location parameters.

Action Parameters

No parameters are required for this action

Action Output

No Output

action: 'put data'

Perform a REST PUT call to the server

Type: generic
Read only: False

Action Parameters

PARAMETER REQUIRED DESCRIPTION TYPE CONTAINS
location required Location (e.g. path/to/endpoint?query=string) string endpoint
body required PATCH body (query string, JSON, etc.) string
verify_certificate optional Verify certificates (if using HTTPS) boolean
headers optional Additional headers (JSON object with headers) string

Action Output

DATA PATH TYPE CONTAINS
action_result.status string
action_result.parameter.body string
action_result.parameter.headers string
action_result.parameter.location string endpoint
action_result.parameter.verify_certificate boolean
action_result.data.*.location string url
action_result.data.*.method string
action_result.data.*.parsed_response_body string
action_result.data.*.response_body string
action_result.data.*.response_headers string
action_result.summary.reason string
action_result.summary.status_code numeric
action_result.message string
summary.total_objects numeric
summary.total_objects_successful numeric

action: 'patch data'

Perform a REST PATCH call to the server

Type: generic
Read only: False

Action Parameters

PARAMETER REQUIRED DESCRIPTION TYPE CONTAINS
location required Location (e.g. path/to/endpoint?query=string) string endpoint
body optional PATCH body (query string, JSON, etc.) string
verify_certificate required Verify certificates (if using HTTPS) boolean
headers optional Additional headers (JSON object with headers) string

Action Output

DATA PATH TYPE CONTAINS
action_result.status string
action_result.parameter.body string
action_result.parameter.headers string
action_result.parameter.location string endpoint
action_result.parameter.verify_certificate boolean
action_result.data.*.location string url
action_result.data.*.method string
action_result.data.*.parsed_response_body string
action_result.data.*.response_body string
action_result.data.*.response_headers string
action_result.summary.reason string
action_result.summary.status_code numeric
action_result.message string
summary.total_objects numeric
summary.total_objects_successful numeric

action: 'delete data'

Perform a REST DELETE call to the server

Type: generic
Read only: False

Action Parameters

PARAMETER REQUIRED DESCRIPTION TYPE CONTAINS
location required Location (e.g. path/to/endpoint?query=string) string endpoint
body optional DELETE body (query string, JSON, etc.) string
verify_certificate required Verify certificates (if using HTTPS) boolean
headers optional Additional headers (JSON object with headers) string

Action Output

DATA PATH TYPE CONTAINS
action_result.status string
action_result.parameter.body string
action_result.parameter.headers string
action_result.parameter.location string endpoint
action_result.parameter.verify_certificate boolean
action_result.data.*.location string url
action_result.data.*.method string
action_result.data.*.parsed_response_body string
action_result.data.*.response_body string
action_result.data.*.response_headers string
action_result.summary.reason string
action_result.summary.status_code numeric
action_result.message string
summary.total_objects numeric
summary.total_objects_successful numeric

action: 'get headers'

Perform a REST HEAD call to the server

Type: investigate
Read only: True

Action Parameters

PARAMETER REQUIRED DESCRIPTION TYPE CONTAINS
location required Location (e.g. path/to/endpoint?query=string) string endpoint
verify_certificate required Verify certificates (if using HTTPS) boolean
headers optional Additional headers (JSON object with headers) string

Action Output

DATA PATH TYPE CONTAINS
action_result.status string
action_result.parameter.headers string
action_result.parameter.location string endpoint
action_result.parameter.verify_certificate boolean
action_result.data.*.location string url
action_result.data.*.method string
action_result.data.*.response_headers string
action_result.summary.reason string
action_result.summary.status_code numeric
action_result.message string
summary.total_objects numeric
summary.total_objects_successful numeric

action: 'get options'

Perform a REST OPTIONS call to the server

Type: investigate
Read only: True

Action Parameters

PARAMETER REQUIRED DESCRIPTION TYPE CONTAINS
location required Location (e.g. path/to/endpoint?query=string) string endpoint
verify_certificate required Verify certificates (if using HTTPS) boolean
headers optional Additional headers (JSON object with headers) string

Action Output

DATA PATH TYPE CONTAINS
action_result.status string
action_result.parameter.headers string
action_result.parameter.location string endpoint
action_result.parameter.verify_certificate boolean
action_result.data.*.location string url
action_result.data.*.method string
action_result.data.*.parsed_response_body string
action_result.data.*.response_body string
action_result.data.*.response_headers string
action_result.summary.reason string
action_result.summary.status_code numeric
action_result.message string
summary.total_objects numeric
summary.total_objects_successful numeric

action: 'get data'

Perform a REST GET call to the server

Type: investigate
Read only: True

Action Parameters

PARAMETER REQUIRED DESCRIPTION TYPE CONTAINS
location required Location (e.g. path/to/endpoint?query=string) string endpoint
verify_certificate required Verify certificates (if using HTTPS) boolean
headers optional Additional headers (JSON object with headers) string

Action Output

DATA PATH TYPE CONTAINS
action_result.status string
action_result.parameter.headers string
action_result.parameter.location string endpoint
action_result.parameter.verify_certificate boolean
action_result.data.*.location string url
action_result.data.*.method string
action_result.data.*.parsed_response_body string
action_result.data.*.response_body string
action_result.data.*.response_headers string
action_result.summary.reason string
action_result.summary.status_code numeric
action_result.message string
summary.total_objects numeric
summary.total_objects_successful numeric

action: 'post data'

Perform a REST POST call to the server

Type: generic
Read only: False

Action Parameters

PARAMETER REQUIRED DESCRIPTION TYPE CONTAINS
location required Location (e.g. path/to/endpoint) string endpoint
body required POST body (query string, JSON, etc.) string
verify_certificate required Verify certificates (if using HTTPS) boolean
headers optional Additional headers (JSON object with headers) string

Action Output

DATA PATH TYPE CONTAINS
action_result.status string
action_result.parameter.body string
action_result.parameter.headers string
action_result.parameter.location string endpoint
action_result.parameter.verify_certificate boolean
action_result.data.*.location string url
action_result.data.*.method string
action_result.data.*.parsed_response_body string
action_result.data.*.response_body string
action_result.data.*.response_headers string
action_result.summary.reason string
action_result.summary.status_code numeric
action_result.message string
summary.total_objects numeric
summary.total_objects_successful numeric

action: 'get file'

Retrieve a file from the endpoint and save it to the vault

Type: investigate
Read only: True

Provide the file path and file name to download into the vault. For example, /web_storage/file.tgz.

Action Parameters

PARAMETER REQUIRED DESCRIPTION TYPE CONTAINS
hostname required Hostname to execute command on string host name
file_path required Path of the file to download (include filename) string file path

Action Output

DATA PATH TYPE CONTAINS
action_result.status string
action_result.parameter.file_path string file path
action_result.parameter.hostname string host name
action_result.data string
action_result.summary.exit_status numeric
action_result.summary.name string
action_result.summary.size numeric
action_result.summary.vault_id string vault id
action_result.message string
summary.total_objects numeric
summary.total_objects_successful numeric

action: 'put file'

Put a file from the vault to another location

Type: generic
Read only: False

Provide the path to store the file on the file server. For example, /web_storage/test_repo/.

Action Parameters

PARAMETER REQUIRED DESCRIPTION TYPE CONTAINS
host required Hostname/IP with port number to execute command on string host name
vault_id required Vault ID of file string vault id
file_destination required File destination path (exclude filename) string file path

Action Output

DATA PATH TYPE CONTAINS
action_result.status string
action_result.parameter.file_destination string file path
action_result.parameter.host string host name
action_result.parameter.vault_id string vault id
action_result.data string
action_result.summary.file_sent string file path
action_result.message string
summary.total_objects numeric
summary.total_objects_successful numeric

About

No description, website, or topics provided.

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages