Configuring HTTP proxies

This guide will teach how to configure and use an HTTP proxy in Alumio. HTTP proxies allow users to configure an API call which forwards the call to an external system.

Creating HTTP proxies

Go to Connections > HTTP Proxies. A table is shown with all previously created HTTP proxies. Click the add button on the page to add a new HTTP proxy.

Overview of HTTP proxies

HTTP Proxy Form

A form is shown to create a new HTTP Proxy. Fill in the basic information: a name, identifier and description. Then enter the URL which needs to be called, and the HTTP method that needs to be used.

If required a HTTP client can be configured via the HTTP Client field. Custom headers, authentication, etc can be added here.

A matcher can be added to add authentication of the HTTP proxy API call. By default no authentication is added which means guests can call the API. It's recommended to require an Authorization header or a similar solution.

HTTP proxy form

Using an HTTP proxy

The HTTP proxy can be used via the Alumio API. See the example below. All request data like the headers and request body will be forwarded to the configured URL. The API will return the response, including response headers of the configured URL.

POST
https://{alumio-host}/api/v1/http-proxy/{http-proxy-identifier}