HTTP Gateway Service
The following table describes the additional fields for the HTTP Gateway service.
| Field | Sub-Field | Description | Default (if any) |
|---|---|---|---|
| Dynamic Learn Mode Header | The header that will be used to send a request to enable the learn mode for a particular URI. | ||
| Auto Handle Domain Name Rewrite | Adds the domain name, rewrites the filters and the rules that replace the host name in the forwarded requests or responses as per the target or source hostname. | ||
| Outbound Transport Settings | Name-Value pairs used with the outbound transport. | ||
| Authentication Cache Timeout | Define the amount of time for which the username and password in the REST request is stored in cache. | 900 seconds | |
| Error Metrics Logging | Enable if you want to log the detailed error metrics, such as the total number of errors, the offset where the error was encountered, the reasons why the error was encountered, the ruleset details, and so on. | ||
| Enabled | Enable or disable error metrics to be logged in the log file. | ||
| Log Level |
| ||
| Error Code | Set one HTTP status code for the errors that may occur in the file while processing it. Select from the following HTTP status codes:
| 200 OK |
The options for the Outbound Transport Settings field in the HTTP Gateway are described in the following table.
| Option | Description | Default |
|---|---|---|
| auth_mode | Authentication mode digest or basic. | basic |
| auth_username | Username for HTTP authentication. | n/a |
| auth_password | Password for HTTP authentication. | n/a |
| connect_timeout | Timeout for initial connection in seconds. | 300 |
| request_timeout | Timeout for the entire request in seconds. | 180 |
| network_interface | Network interface used for the request. | n/a |
| proxy_host* | HTTP proxy hostname. | n/a |
| proxy_port* | HTTP proxy port. | n/a |
| proxy_username* | HTTP proxy username. | n/a |
| proxy_password* | HTTP proxy password. | n/a |
| validate_cert | Validation required for the server certificate. | n/a |
| ca_certs | Filename of the CA certificates in PEM format only. | n/a |
| client_key | Filename for the client SSL key. | n/a |
| client_cert | Filename for the client SSL certificate. | n/a |
| allow_nonstandard_methods | Flag to allow nonstandard HTTP method constructions such as HTTP PUT method with no body content. | false |
| max_599_retries | Maximum number of retries for the gateway to send a request to the server when a status code of 599 occurs. | 1 Minimum: 1 Maximum: 5 |
| Error Metrics Logging | Enable if you want to log the detailed error metrics, such as the total number of errors, the offset where the error was encountered, the reasons why the error was encountered, the ruleset details, and so on. | |
| Enabled | Enable or disable error metrics to be logged in the log file. | |
| Log Level |
| |
| Error Code | Set one HTTP status code for the errors that may occur in the file while processing it. Select from the following HTTP status codes:
| 200 OK |
Note: If you set the value of max_599_retries less than 1, the value is automatically set to 1. If you set the value of max_599_retries greater than 5, the value is automatically set to 5.
* - The DSG uses the proxy parameters to forward the outgoing requests from DSG through the proxy. The DSG supports any proxy that can handle HTTP CONNECT method for tunnelling HTTPS connections.
The following snippet describes the format for the Outbound Transport Settings field:
{
"connect\_timeout": 100,
"request\_timeout": 100,
"ca\_certs": "/opt/cert.cer",
"max\_599\_retries": 4
}
In the above example, the connect timeout is set as 100 seconds, the request timeout is set as 100 seconds, and the path for the CA certificate is specified.
The curl is a command-line tool to transfer data between servers. This tool supports protocols such as HTTP, HTTPS, FTP, FTPS, GOPHER, DICT, LDAP, TELNET, FILE, and so on. The features supported by curl include user authentication, proxy support, cookies, HTTP post, FTP upload, file transfer resume, SSL connections, and so on.
The Gateway uses curl stack for outbound HTTP transport. You can use the curl options in the Outbound Transport Settings field.
| Option | Description | Default |
|---|---|---|
| RESOLVE | Allows to resolve a request hostname to an IP address. | n/a |
| TCP_NODELAY | Setting this option disables the TCP Nagle algorithm. The field accepts the following values:
| 1 |
The format for the curl options in the Outbound Transport Settings field is shown in the following example.
In this example, the hostname www.protegrity.com resolves to the IP address 2.10.1.4, while the hostname else.domain.com resolves to the IP address 2.10.2.3. The TCP_NODELAY option is set to 1, indicating that the Nagle algorithm is disabled.
{
"network\_interface": "ethMNG",
"validate\_cert": false,
"options": {
"RESOLVE": [
"www.protegrity.com:443:2.10.1.4",
"else.domain.com:443:2.10.2.3"
],
"TCP\_NODELAY": 1
}
}
Feedback
Was this page helpful?