Sign Up for Free

RunKit +

Try any Node.js package right in your browser

This is a playground to test code. It runs a full Node.js environment and already has all of npm’s 400,000 packages pre-installed, including @axway/api-builder-plugin-fn-restclient with all npm packages installed. Try it out:

require("@axway/api-builder-runtime/package.json"); // @axway/api-builder-runtime is a peer dependency. var apiBuilderPluginFnRestclient = require("@axway/api-builder-plugin-fn-restclient")

This service is provided by RunKit and is not affiliated with npm, Inc or the package authors.

@axway/api-builder-plugin-fn-restclient v2.0.17

Axway Flow Engine HTTP REST node.



This module installs the REST flow-node plugin to be used within Axway API Builder's flow editor. The flow-node provides methods for the HTTP verbs GET, HEAD, OPTIONS, DELETE, POST, PUT and PATCH.

Common Parameters

All methods have these parameters:

URLstringyThe target HTTP URL.
HeadersobjectnThe headers to send with the request.
InsecurebooleannDo not require the SSL certificates to be valid. Default: False
Follow redirectbooleannFollow HTTP 3xx responses as redirects. Default: True
Maximum redirectsintegernThe maximum number of redirects to follow before aborting. Default: 10

Response format: HEAD, OPTIONS, DELETE

These verbs do not respond with a body. The response consists of {status, headers}.

Response format: GET, POST, PUT, PATCH

These verbs may respond with a body. The response consists of {status, headers, body}.

Getting started

  1. Follow the Getting Started Guide


npm install --no-optional @axway/api-builder-plugin-fn-restclient

The "REST" flow-node will then be available in the tools panel when creating or editing Flows.



  • #6116: Internal cleanup chore.


  • #6074: Internal CI chore

2.0.9 - 2.0.15

  • #5891: Bump axway-flow-sdk dependency


  • #5742: Fix issue where axway-flow-sdk dependency was out of sync with the latest. dot security warning is now resolved.


  • #5711: Internal cleanup of npm scripts.


  • #5708: Internal changes to update mocha configuration


  • #5709: Internal changes to update eslint rules.


  • #5707: Internal cleanup to code coverage during build process.


  • #5742: Update axway-flow-sdk dependency to remove security warning about dot package.


  • #5515: Fix REST response encoding typo.


  • #5436: Moves advanced HTTP options into a new group, "Advanced HTTP Options" (minimum peer dependency @axway/api-builder-runtime 4.5.0)


  • #5172: Support downloading binary files in REST node.


  • #5178: Adds support for communication via proxy server. It takes into account the value of config parameter named proxy which must contain the location of a proxy server through which communication is tunneled. Basic auth is also supported if the value of the proxy is of the format - 'protocol://username:password@location:port'


  • #5050: Updating license text.


  • #4757: Changed SCM repository and associated internal cleanup.


This code is proprietary, closed source software licensed to you by Axway. All Rights Reserved. You may not modify Axway’s code without express written permission of Axway. You are licensed to use and distribute your services developed with the use of this software and dependencies, including distributing reasonable and appropriate portions of the Axway code and dependencies. Except as set forth above, this code MUST not be copied or otherwise redistributed without express written permission of Axway. This module is licensed as part of the Axway Platform and governed under the terms of the Axway license agreement (General Conditions) located here:; EXCEPT THAT IF YOU RECEIVED A FREE SUBSCRIPTION, LICENSE, OR SUPPORT SUBSCRIPTION FOR THIS CODE, NOTWITHSTANDING THE LANGUAGE OF THE GENERAL CONDITIONS, AXWAY HEREBY DISCLAIMS ALL SUPPORT AND MAINTENANCE OBLIGATIONS, AS WELL AS ALL EXPRESS AND IMPLIED WARRANTIES, INCLUDING BUT NOT LIMITED TO IMPLIED INFRINGEMENT WARRANTIES, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, AND YOU ACCEPT THE PRODUCT AS-IS AND WITH ALL FAULTS, SOLELY AT YOUR OWN RISK. Your right to use this software is strictly limited to the term (if any) of the license or subscription originally granted to you.

RunKit is a free, in-browser JavaScript dev environment for prototyping Node.js code, with every npm package installed. Sign up to share your code.
Sign Up for Free