For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Open sourceSupportFAQsDocs Home
  • Introduction
    • Overview
    • Retired adapters
      • Overview
        • Overview
        • Base properties
        • Authentication properties
        • SSL/TLS properties
        • Request properties
        • Healthcheck properties
        • Proxy properties
        • Throttle properties
        • Mongo properties
        • Deprecated properties
      • SSL/TLS
      • Throttling
      • Headers
      • Add dynamic headers
      • Add query parameters
      • Update adapter configuration
LogoLogo
Open sourceSupportFAQsDocs Home
On this page
  • Properties
  • Example
ConfigureService instance configuration

Request properties

Was this page helpful?
Previous

Healthcheck properties

Next
Built with

All request properties are defined within the request object in theItential Platform service instance configuration for the adapter.

Properties

PropertyTypeRequiredDescription
number_redirectsintegerNo → 0The maximum number of redirects to follow before returning an error. Set to 0 to disallow redirects.
number_retriesintegerYesThe number of times to retry a failed request (for errors matching limit_retry_error) before returning an error.
limit_retry_errorinteger or arrayYesThe error code or codes that should trigger a retry. Supports an array of integers or ranges. Example: [401, "500-599"]
failover_codesarray of integersNoError codes that cause the adapter to return a response instructingItential Platform to route the request through another adapter, if one is available.
attempt_timeoutintegerYesTime in milliseconds after which the adapter aborts a request. The request may be retried after a successful healthcheck.
global_requestobjectNoStatic data to include in every request the adapter makes. All values must be static — dynamic values should be handled in adapter.js. Sub-fields: payload (static body fields), uriOptions (static query parameters), addlHeaders (static headers), authData (static authentication data).
healthcheck_on_timeoutbooleanYesWhen true, the adapter runs a healthcheck after a request times out to verify the external system is still available.
return_rawbooleanNoWhen true, returns the raw response alongside the processed result. Useful for collecting mock data.
archivingbooleanNoDeprecated. Do not use except in lab environments for adapter testing.
return_requestbooleanNoWhen true, returns the outbound request data along with the response. Note that this may include authentication information.

Example

This example retries on 501 errors up to five times, aborts requests after 60 seconds, and adds a static SimonSays header to every call.

1"request": {
2  "number_redirects": 0,
3  "number_retries": 5,
4  "limit_retry_error": 501,
5  "failover_codes": [],
6  "attempt_timeout": 60000,
7  "global_request": {
8    "payload": {},
9    "uriOptions": {},
10    "addlHeaders": {
11      "SimonSays": "Please"
12    },
13    "authData": {}
14  },
15  "healthcheck_on_timeout": true,
16  "return_raw": false,
17  "archiving": false
18}