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. | Governemnt_APIs |
URL | The URL of the request. Input literal values or expressions with attributes encapsulated within ${} syntax, for example This URL will act as a prefix to the URL on the HTTP Action i.e. the URL defined on the HTTP Action will be added to this one. However, if the HTTP Action's URL starts with http, mailto or callto, this URL will not be used at all. | https://api.example.com |
Headers
Headers are typically used to specify information for the request, such as the character set being used, session tokens or passwords. Headers can make use of the PhixFlow 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
Excerpt | ||
---|---|---|
| ||
Rate limiting can be used to limit traffic and help stability. It works by restricting the number of requests that can be sent. |
Excerpt | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Rate Limiting Example
Request Capacity: 80 Request Capacity Rate: 30000ms Maximum Rollover Requests: 101
|
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. |