GatewayScript APIs

The DataPower® Gateway provides GatewayScript APIs to define custom processing.

apigw module
The apigw module offers APIs specific to the API gateway.
assert module
The assert module is used for writing unit tests for applications.
buffer object
The buffer object contains contiguous binary data.
Buffers object
A buffers object is a collection of individual buffer objects.
clearTimeout()
The clearTimeout() API clears a timeout event by ID.
console module
Use the methods in the console module to write a log message to the DataPower system log.
context object
The APIs for the context objects differ when used by the GatewayScript assembly action and the GatewayScript processing action.
crypto module
The crypto module offers a set of APIs for cryptographic usage. It provides the hash, HMAC, cipher, decipher, sign, and verify APIs.
error object
The error object interrogates the results of errors that are thrown or errors that are returned as part of asynchronous function calls.
fs module
The fs module provides APIs to access the file system.
headers module
The GatewayScript headers module provides methods to access the protocol headers in requests or responses.
jose module
The jose module provides APIs to encrypt and decrypt messages and to sign and verify messages. Encryption and decryption use JSON Web Encryption (JWE) specifications. Signing and verifying messages use JSON Web Signature (JWS) specifications.
json-xml-converter module
The json-xml-converter module provides APIs for conversion between JSON and XML objects.
jwk module
The jwk module offers a set of APIs for JSON Web Key (JWK) verification and conversion.
jwt module
The jwt module offers a set of APIs to create and validate a JSON Web Token (JWT).
multistep module
The multistep module is used for the service to call a processing rule directly from GatewayScript actions.
XML.parse()
Parses well-formed strings into DOM Document objects.
policy-utility module
The policy-utility module provides several methods to interface with the policy enforcement engine, including methods to define the policy enforcement map and to modify the sequence of policies to enforce.
punycode module
The punycode module provides utilities for converting between Unicode code points and strings of punycode ASCII code points.
querystring module
The querystring module provides APIs to parse and format URL query strings.
ratelimit module
With the APIs in the ratelimit module, you can define keys that represent rate thresholds, counters, and concurrent transactions.
service-metadata module
Use the service-metadata module to access service variables.
session object
GatewayScript can access transaction information through session objects.
setTimeout()
The setTimeout() API schedules a callback function after a specific duration.
XML.stringify()
The XML.stringify() API transforms XML DOM node objects into strings.
system-metadata module
Use the system-metadata module to access system variables.
transform module
The transform provides methods to access and manipulate the data in an XML document.
url module
The url module provides the URL parsing utilities.
urlopen module
The urlopen module provides APIs to establish a nonstreaming connection with target servers by HTTP, HTTPS, Kafka, or IBM® MQ protocol and open files in the DataPower file system. The APIs can also send and receive IBM MQ messages within a GatewayScript action.
util module
The util module provides some general-purpose utilities.

Parent topic: Gateway programming model and GatewayScript