V2

OpenAPI REST Request

Provides an HTTP client node that can execute REST operations from an imported OpenAPI specification or a manually configured request. Use it to quickly scaffold calls against documented APIs with template-driven parameters.

Revision History

1.0.0.0 - 2025/10/30 - Initial release.
1.0.0.3 - 2026/01/20 - Fixed shared OAuthConnection lock handling.
1.0.0.4 - 2026/01/21 - Fixed error message handling.
0.0.0.9 - Node name correction.

Setup Notes

  • Import an OpenAPI document to generate templates for supported operations.
  • Define any reusable headers (for example authentication or correlation IDs) on the connection to avoid duplicating values on each request.

Connection

Parameter Type Description
Base URL String The root URL for the target service (for example: https://api.example.com).
Authentication Type String Authentication mode (for example: None, API Key, or Bearer Token).
API Key Header Name String Name of the header that carries the API key when using API key authentication.
API Key Masked API key value sent with each request when the authentication type is API Key.
Bearer Token Masked Token sent in the Authorization header when using bearer authentication.
Default Headers Object Optional dictionary of header names and values that will be applied to every request.

Functions

Process

Parameter Type Notes
Connection Connection Connection profile containing the base URL and authentication settings.
Operation ID String Operation identifier from the imported OpenAPI document.
Parameters Dictionary<string, object> Key-value parameters resolved into the request path, query, or headers.
Body IAsyncEnumerable Optional body payload streamed into the request for operations that accept content.
Return Type Notes
Result IAsyncEnumerable Response content returned from the target operation.

Known Issues

  • None currently known.