Connect
Self-Managed Only

dynamic

A special broker type where the inputs are identified by unique labels and can be created, changed and removed during runtime via a REST HTTP interface.

inputs:
  label: ""
  dynamic:
    inputs: {}
    prefix: ""

Fields

bind_http

Whether to register the REST HTTP endpoints (/inputs, /inputs/{id}, and so on) for creating, updating and removing inputs at runtime. These endpoints are served on the service-wide HTTP server and accept input configuration over HTTP, so they are disabled by default. Enable them only when that server is secured appropriately, for example bound to a trusted interface or protected with http.basic_auth.

Type: bool

Default: false

inputs

A map of inputs to statically create.

Type: object

Default: {}

prefix

A path prefix for HTTP endpoints that are registered.

Type: string

Default: ""

Endpoints

GET /inputs

Returns a JSON object detailing all dynamic inputs, providing information such as their current uptime and configuration.

GET /inputs/{id}

Returns the configuration of an input.

POST /inputs/{id}

Creates or updates an input with a configuration provided in the request body (in YAML or JSON format).

DELETE /inputs/{id}

Stops and removes an input.

GET /inputs/{id}/uptime

Returns the uptime of an input as a duration string (of the form "72h3m0.5s"), or "stopped" in the case where the input has gracefully terminated.