About the connector
HTTP connector provides HTTP requests.
This document provides information about the HTTP connector, which facilitates automated interactions, with an HTTP server using FortiSOAR™ playbooks. Add the HTTP connector as a step in FortiSOAR™ playbooks and perform automated operations, such as performing HTTP requests such as GET, POST, and OPTIONS operations on the configured server.
Version information
Connector Version: 1.0.0
Compatibility with FortiSOAR™ Versions: 4.10.3-161 and later
Compatibility with HTTP Version: 1.0 and later
Installing the connector
Use the Content Hub to install the connector. For the detailed procedure to install a connector, click here.
You can also use the following yum command as a root user to install connectors from an SSH session:
yum install cyops-connector-http
Prerequisites to configuring the connector
- You must have the URL and Port of the HTTP server to which you will connect and perform the automated operations.
- The FortiSOAR™ server should have outbound connectivity to port 443 on the HTTP server.
Minimum Permissions Required
Configuring the connector
For the procedure to configure a connector, click here.
Configuration parameters
In FortiSOAR™, on the Content Hub (or Connector Store) page, click the Manage tab, and then click the HTTP connector card. On the connector popup, click the Configurations tab to enter the required configuration details:
| Parameter |
Description |
| Server URL |
URL of the HTTP server on which you will perform HTTP request operations. |
| API Key |
Port number used for connecting to the HTTP server. |
| Verify SSL |
Specifies whether the SSL certificate for the server is to be verified or not.
By default, this option is set as True. |
Actions supported by the connector
The following automated operations can be included in playbooks and you can also use the annotations to access operations from FortiSOAR™ release 4.10.0 onwards:
| Function |
Description |
Annotation and Category |
| HTTP GET Request |
Performs an HTTP GET Request operation, with the specified input parameters, on the configured HTTP server. |
request_get
Investigation |
| HTTP POST Request |
Performs an HTTP POST Request operation, with the specified input parameters, on the configured HTTP server. |
request_post
Investigation |
| HTTP PUT Request |
Performs an HTTP PUT Request operation, with the specified input parameters, on the configured HTTP server. |
request_put
Investigation |
| HTTP OPTIONS Request |
Performs an HTTP OPTIONS Request operation, with the specified input parameters, on the configured HTTP server. |
request_options
Investigation |
| HTTP HEAD Request |
Performs an HTTP HEAD Request operation, with the specified input parameters, on the configured HTTP server. |
request_head
Investigation |
| HTTP DELETE Request |
Performs an HTTP DELETE Request operation, with the specified input parameters, on the configured HTTP server. |
request_delete
Investigation |
| HTTP PATCH Request |
Performs an HTTP PATCH Request operation, with the specified input parameters, on the configured HTTP server. |
request_patch
Investigation |
operation: HTTP GET Request
Input parameters
| Parameter |
Description |
| Rest API |
(Optional) REST API for the configured server (if required) on which you want to perform the HTTP GET Request operation.
For example, path/to/endpoint?query=string or path/ |
| Request Header |
(Optional) The header for the HTTP GET Request. |
| Request Parameters |
(Optional) Inline parameters that you want to add to the HTTP GET Request. |
Output
The JSON output contains the response of the HTTP GET Request operation, with the parameters you have specified, returned by the configured HTTP server.
operation: HTTP POST Request
Input parameters
| Parameter |
Description |
| Rest API |
(Optional) REST API for the configured server (if required) on which you want to perform the HTTP POST Request operation.
For example, path/to/endpoint?query=string or path/ |
| Request Header |
(Optional) The header for the HTTP POST Request. |
| Request Data |
(Optional) Payload (Data) for the HTTP POST Request. |
| Request Parameters |
(Optional) Inline parameters that you want to add to the HTTP POST Request. |
Output
The JSON output contains the response of the HTTP POST Request operation, with the parameters you have specified, returned by the configured HTTP server.
operation: HTTP PUT Request
Input parameters
| Parameter |
Description |
| Rest API |
(Optional) REST API for the configured server (if required) on which you want to perform the HTTP PUT Request operation.
For example, path/to/endpoint?query=string or path/ |
| Request Header |
(Optional) The header for the HTTP PUT Request. |
| Request Data |
(Optional) Payload (Data) for the HTTP PUT Request. |
| Request Parameters |
(Optional) Inline parameters that you want to add to the HTTP PUT Request. |
Output
The JSON output contains the response of the HTTP PUT Request operation, with the parameters you have specified, returned by the configured HTTP server.
operation: HTTP OPTIONS Request
Input parameters
| Parameter |
Description |
| Rest API |
(Optional) REST API for the configured server (if required) on which you want to perform the HTTP OPTIONS Request operation.
For example, path/to/endpoint?query=string or path/ |
| Request Header |
(Optional) The header for the HTTP OPTIONS Request. |
Output
The JSON output contains the response of the HTTP OPTIONS Request operation, with the parameters you have specified, returned by the configured HTTP server.
operation: HTTP HEAD Request
Input parameters
| Parameter |
Description |
| Rest API |
(Optional) REST API for the configured server (if required) on which you want to perform the HTTP HEAD Request operation.
For example, path/to/endpoint?query=string or path/ |
Output
The JSON output contains the response of the HTTP HEAD Request operation, with the parameters you have specified, returned by the configured HTTP server.
operation: HTTP DELETE Request
Input parameters
| Parameter |
Description |
| Rest API |
(Optional) REST API for the configured server (if required) on which you want to perform the HTTP DELETE Request operation.
For example, path/to/endpoint?query=string or path/ |
| Request Header |
(Optional) The header for the HTTP DELETE Request. |
| Request Data |
(Optional) Payload (Data) for the HTTP DELETE Request. |
| Request Parameters |
(Optional) Inline parameters that you want to add to the HTTP DELETE Request. |
Output
The JSON output contains the response of the HTTP DELETE Request operation, with the parameters you have specified, returned by the configured HTTP server.
operation: HTTP PATCH Request
Input parameters
| Parameter |
Description |
| Rest API |
(Optional) REST API for the configured server (if required) on which you want to perform the HTTP PATCH Request operation.
For example, path/to/endpoint?query=string or path/ |
| Request Header |
(Optional) The header for the HTTP PATCH Request. |
| Request Data |
(Optional) Payload (Data) for the HTTP PATCH Request. |
| Request Parameters |
(Optional) Inline parameters that you want to add to the HTTP PATCH Request. |
Output
The JSON output contains the response of the HTTP PATCH Request operation, with the parameters you have specified, returned by the configured HTTP server.
Included playbooks
The Sample - HTTP - 1.0.0 playbook collection comes bundled with the HTTP connector. This playbook contains steps using which you can perform all supported actions. You can see the bundled playbooks in the Automation > Playbooks section in FortiSOAR™ after importing the HTTP connector.
- HTTP DELETE Request
- HTTP GET Request
- HTTP HEAD Request
- HTTP OPTIONS Request
- HTTP PATCH Request
- HTTP POST Request
- HTTP PUT Request
Note: If you are planning to use any of the sample playbooks in your environment, ensure that you clone those playbooks and move them to a different collection, since the sample playbook collection gets deleted during connector upgrade and delete.
