http::configuration-id
Returns this HTTP instance's configuration entry ID, without its value.
Empty object
- idstringrequired
http
v0.22.7Expose functions as HTTP endpoints — registers the `http` trigger type and serves matched routes.
Install
bash
iii trigger compose::add worker=httpRun in your project with the iii engine running. Exact versions are immutable and digest-pinned.
Functions4
Function
http::on-config-change
Internal: reload http configuration from the authoritative store on change.
Empty object
- okbooleanrequired
http::status
Where the public HTTP server listens: its host, its port and the base URL to open from this machine (for example http://127.0.0.1:3111). Read-only; use it instead of assuming port 3111.
Empty object
- hoststring
The bound interface (`0.0.0.0` serves every network interface). None while the server is stopped.
- last_reload_errorstring
Last configuration reload failure, e.g. the port is already in use; cleared by the next successful reload.
- portinteger· uint16min 0
The bound port (the OS-assigned one for port 0). None while stopped.
- urlstring
The base URL to open from this machine, e.g. `http://127.0.0.1:3111`: loopback when the server listens on every interface.
http::webhook-listener::status
Internal: the restricted webhook listener this process has actually bound and the last reload error.
Empty object
- appliedany of
The listener this process has bound: the last successfully applied configuration (a failed bind keeps the previous one). None when the listener is off or the server is stopped.
any of (2)Variant 1- hoststring
Loopback by default; expose only this listener through a reverse proxy.
- portinteger· uint16min 0
Restricted port, separate from the normal listener (3111).
Variant 2valuenull - last_reload_errorstring
Last configuration reload failure, e.g. the port is already in use; cleared by the next successful reload.
Triggers1
http
HTTP API trigger
- api_pathstringrequired
- condition_function_idstring
- http_methodstring
- middleware_function_idsstring[]
- public_webhookboolean
Also expose this route on the restricted webhook listener. Explicit opt-in only; the default keeps existing routes on the normal listener.
- bodyunknownrequired
- headersobjectrequired
- methodstringrequired
- pathstringrequired
- path_paramsobjectrequired
- query_paramsobjectrequired
- request_bodyobjectrequired
- access_keystringrequired
- channel_idstringrequired
- directionstringrequiredenum read, write
- responseobjectrequired
- access_keystringrequired
- channel_idstringrequired
- directionstringrequiredenum read, write
- triggerany ofany of (2)Variant 1
- methodstring
- pathstring
- typestringrequired
Variant 2valuenull