API Gateway Path Settings
  • 20 Mar 2023
  • 2 Minutes to read
  • Contributors
  • Dark
  • PDF

API Gateway Path Settings

  • Dark
  • PDF

Beta version

The product is currently in the Beta version and has limited availability and functionality

Path (resource) configuration settings

When creating a new API Gateway path (resource) the following settings are available:


  1. Path - path you want to send requests to, must start with the "/";
  2. Method - selects the request method. The following options are available: GET, POST, PUT, PATCH, DELETE;
API path settings and the request method used

When sending requests to an API path (resource) you must use the same method as you've selected in the path settings.

Request method used for the Synchronous operation

When Async option is disabled, it is mandatory for the process specified in the Process ID field to contain an API Call node. Remember to select POST both for the API Gateway parameter and for the Request method parameter of the API Call node.

  1. Process ID - ID of a process to which the request data is sent in a task;

To upload the data processed in Corezoid back to API Gateway in the Synchronous mode, you need to have an API Call node in the specified process. API Gateway provides a callback URL via the api_gateway.callback_url field of request data, and you just need to specify the URL in an API Call node's settings:

api request url.png

  1. Description - text description of your API (optional);
  2. Timeout - maximum interval of API Gateway's waiting for a response from Corezoid in the Synchronous mode. Can be set to any value in the range from 0 to 29 seconds;
  3. Public - when enabled (default) it is required to provide a Corezoid API key for public routes in the field below. When disabled no API key is required;
  4. Async - when disabled (default) the Synchronous operation mode is used, and the API Gateway expects a response from Corezoid during the interval specified in the Timeout. When enabled, the API Gateway does not wait for a response from Corezoid and responds with the 204 code to a client;
  5. Proxy headers - when checked, request headers are sent to the specified process in a task;
  6. Proxy raw body - when checked, any input data format is sent in a task as a string. When unchecked, input data is sent as JSON.

Proxy raw body

In addition to a standard JSON format, you can use any format for inputting data in the API Gateway. If you need to send data to the specified process in a format other than JSON, check the Proxy raw body box and the data will be sent as a string.
However, with XML in your request body, you have a conversion option. API Gateway can convert XML data to JSON before sending it to Corezoid in a task. To send XML-format data in your request to Corezoid as JSON, just do the following:

  1. Select either Application/Xml or Text/Xml content type in the API Call node's settings;
  2. Disable the Proxy raw body option in the API Gateway path settings.

With the Proxy raw body unchecked, the XML request:

curl -X POST -H "Content-Type: text/xml" -d '<hello>world</hello>' https://foo.api.the-company.com/bar/baz

will be forwarded to Corezoid with the following body converted to JSON:

{"hello": "world"}