--- title: "API Gateway" slug: "api-gateway" updated: 2026-11-13T08:18:16Z published: 2026-11-13T08:18:16Z canonical: "learn.servitly.com/api-gateway" --- > ## Documentation Index > Fetch the complete documentation index at: https://learn.servitly.com/llms.txt > Use this file to discover all available pages before exploring further. # API Gateway Securely expose third-party existing APIs through the DPS API, ensuring compatibility, protection, and access control. ![](https://cdn.document360.io/6759e9c9-3ce3-49df-965a-7231d2d9a10a/Images/Documentation/image(925).png?sv=2026-02-06&spr=https&st=2026-11-16T23%3A16%3A20Z&se=2026-11-17T00%3A16%3A20Z&sr=b&sp=r&sig=cj4IT0%2Bnk2V6hSmazWvx3mBMr%2F%2Fu19bM9YWK9PKOChE%3D) Once the plugin has been enabled, you can configure the `Endpoints` to republish in the DPS API set. Once complete, you can use a standard DPS API to invoke your own endpoints, masking the actual URL and security information (e.g., API key, tokens). For instance, giving this `Endpoint`: ```http Name: production-forecast Method: GET URL: https://internal.acme.com/api/production/forecast Parameters: machineId=${request.serialNumber} Headers: api-key=abc123 ``` You can invoke a generic DPS API (e.g., from the frontend in a custom widget) that, on the cloud side, makes the real request to the external service endpoint. ```http GET https://acme.servitly.com/api/gateway/production-forecast?serialNumber=M0123 ``` The DPS backend extracts the request parameters and payload (if present) and, based on the configured endpoint, sends the request to the remote endpoint. ```http GET https://internal.acme.com/api/production/forecast?machineId=M0123 api-key=abc123 ``` Within the URL, parameters, headers, and payload, you can use placeholders to make them dynamic. For instance, the placeholder `${request.serialNumber}` is resolved by extracting the `serialNumber` parameter from the request made to the DPS API. All the parameters, defined in the `PARAMTERS` table, are encoded and attached to the URL as a query string using the parameter name and value, which could also be dynamic (`${request.***}`). To propagate the payload (in case of `PUT`, `POST`, `PATCH`), you can use the placeholder `${request.payload}`. The remote endpoint response is synchronously forwarded to the DPS API client who made the initial request. Optionally, you can define the list of [User Types](/v1/docs/user-types) that are authorized to invoke each endpoint. Refer to the [API Documentation](/apidocs/endpoint-get-request) for more details about how to invoke endpoints. If needed, you can test the invocation of your endpoints using the [Webhook](https://webhook.site/) online service. ## Error Codes The DPS `/api/gateway` endpoint may return these codes. - *400 (Bad Request)*: If the payload is missing for `POST`, `PUT`, or `PATCH`. - *401 (Unauthorized)*: If the User Type associated with the user who made the request is not authorized. - *403 (Forbidden)*: If the DPS is not logged in, or its User Type is not authorized. - *404 (Not Found)*: If the endpoint name passed does not exist. - *405 (Method Not Allowed)*: If the endpoint is found by name, but the method does not match. - *408 (Request Timeout)*: If the request to the external service takes more than 60 seconds. - *RESPONSE CODE*: If the request is made to the remote service, any response code is returned to the client that made the initial request. ## Plugin Configuration To enable this plugin, you need to: 1. Go to the Integrations / Plugins page. 2. Select the Data Integration category. 3. Locate the API Gateway card. 4. Click the card switch to activate the plugin. 5. Configure the plugin properties and save. Here is the list of all the properties that can be used in the plugin configuration. | PROPERTY | DESCRIPTION | | --- | --- | | *Endpoints* | The list of remote endpoints you want to integrate into the DPS API. **Type**: ARRAY of ENDPOINTs \| Mandatory | Here are the properties describing a remote `Endpoint` . | PROPERTY | DESCRIPTION | | --- | --- | | *Name* | The string that uniquely identifies the endpoint. This name is used as part of the path in the DPS API endpoint. You can define at most one endpoint with the same `name` and `method`. **Type**: STRING \| Mandatory | | *Method* | The HTTP method to be used to invoke the endpoint. You can define at most one endpoint with the same `name` and `method`. **Type**: ENUM\| Mandatory **Values**: *GET*, *PUT, POST*, *PATCH, DELETE* | | *URL* | The endpoint URL to invoke without the query string. **Type**: STRING \| Mandatory | | *Parameters* | The list of parameters (name and value) to be added to the `URL` as a query string. **Type**: ARRAY \| Optional | | *Headers* | The list of headers (name and value) to be added to the request. **Type**: ARRAY \| Optional | | *Authentication* | You can specify which authentication must be used for the request. You can select one of the configured [Authentications](/v1/docs/authentications-for-third-party-systems), including Microsoft Entra if the [*Microsoft Azure Active Directory*](https://help.servitly.com/hc/en-us/articles/10827673441181) *plugin has been configured*. **Type**: AUTHENTICATION \| Optional | | *Payload* | The text payload to send in case of `PUT`, `POST`, or `PATCH`. To propagate the request payload to the remote service, you can use the placeholder `${request.payload}` in the payload text area of the endpoint. **Type**: STRING \| Optional | | *User Types* | The list of User Types that are authorized to invoke this endpoint via the DPS API. IF empty, all User Types are authorized. **Type**: ARRAY \| Optional |