.. _HttpProxy:

HttpProxy
=========

.. cpp:namespace:: pilot::HttpProxy

Module
------

The `HttpProxy` module provides a HTTP REST API, see :ref:`HTTP`.

Most functions require a special permission, see :ref:`vnx.permission_e`.


Functions
---------

.. cpp:function:: void publish(Object sample, string topic)
	
	Will publish a given ``sample`` on the specified ``topic``.
	Requires permission ``PUBLISH``. See :ref:`vnx.Object`.

.. cpp:function:: Object multi_request(map<string, string> paths) const
	
	Performs multiple ``/api/`` HTTP requests in one.
	``paths`` is a map from paths to output names, for example: ``[["/topic/...", "topic1"], ...]``
	
	The result will be a :ref:`vnx.Object` containing the individual results, for example: ``{"topic1": {...}, ...}``