Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
| Insert excerpt | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Overview
Use
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
HTTP Configurations work in a similar way to
| Insert excerpt | ||||||
|---|---|---|---|---|---|---|
|
| Insert excerpt | ||||||||
|---|---|---|---|---|---|---|---|---|
|
Basic Settings
| Field | Description | Example Value |
|---|---|---|
| Name | Name given to the HTTP Configuration. | BankHolidays |
| URL | The URL of the request. Input literal values or expressions encapsulated within ${} syntax, for example This URL will be overridden if the HTTP Action URL starts with http, mailto or callto. | https://api.example.com |
Headers
Headers are typically used to specify information for the request, such as character sets, session tokens or passwords. Headers can make use of the Secret Key Details see below. For more information see HTTP Header.
For example,
- Name:
Authorization - Expression:
${_datasource.MyAPIKey}
Secret Key Details
Secret Keys allow sensitive data such as passwords or security tokens to be encrypted and stored in the PhixFlow Database.
Secret keys have a name which they can be referenced by using the syntax ${_datasource.keyName}. For full details on secret keys see Secret Key and Local Secret.
Description
We recommend that you always enter a description to explain the purpose of this item.
Rate Limiting
Rate limiting can be used to limit traffic and help stability. This works by restricting the amount of requests that can be sent for HTTP Actions that refer to this HTTP Configuration.
| Field | Description |
|---|---|
| Enable rate limiting | Toggle on or off to restrict the number of requests. |
| Requests gained per time period | Available when Enable rate limiting is enabled. Amount of requests that can be sent, in the Time period for gaining new requests. |
| Time period for gaining new requests (ms) | Available when Enable rate limiting is enabled. The time period, in milliseconds, for sending requests. |
| Maximum rollover requests | Available when Enable rate limiting is enabled. The maximum number of requests that can be saved, to be sent later. |
| Maximum parallel requests | Available when Enable rate limiting is enabled. The maximum number of requests that can be sent at the same time. Note: If more than the allowed number of requests are sent, as soon as a request is finished, another is sent. |
Rate Limiting Example
Requests gained per time period: 20
Time period for gaining new requests: 30000ms
Maximum rollover requests: 25
If 10 requests are sent, then 30000ms later another 30 requests are sent, 25 requests would be sent straight away (up to the maximum), and the other 5 requests would be send another 30000ms later.
Advanced
| Field | Description |
|---|---|
| Connection Timeout (s) | The maximum time to wait to while attempting to create a connection, measured in seconds. The default for this is set to 300 seconds. |
| Response Packet Timeout (s) | The maximum time to wait between responses from the data packets, measured in seconds. The default for this is set to 180 seconds. |