Skip to content

Add per path metadata and the ability to search paths list#5232

Open
eran2903 wants to merge 2 commits intobluenviron:mainfrom
Kela-Systems:contribute-metadata_search_paths
Open

Add per path metadata and the ability to search paths list#5232
eran2903 wants to merge 2 commits intobluenviron:mainfrom
Kela-Systems:contribute-metadata_search_paths

Conversation

@eran2903
Copy link

@eran2903 eran2903 commented Nov 27, 2025

This update adds two improvements to the MediaMTX paths API.

  1. Per-path metadata
    Each path can now include optional metadata fields in its configuration, such as expected bitrate or camera origin. These values are returned in the /v3/paths/list response so that monitoring tools or clients can understand the expected characteristics of each stream.

  2. Path search support
    The /v3/paths/list endpoint now supports a "search" query parameter. It filters the results and returns only the paths whose name starts with the given string. This is useful for grouping paths by camera or any naming prefix.

Example:
curl 'http://127.0.0.1:9997/v3/paths/list?search=cam2'
returns only cam2/main and cam2/sub.

Calling /v3/paths/list without the search parameter returns all paths.

@Snafu
Copy link

Snafu commented Feb 1, 2026

This could also be used to solve issue #5406, instead of the pull request #5405 I made, if the metadata were to be made available as an environment variable for the runOnInit, runOnReady, runOnNotReady, runOnDemand and runOnUnDemand hook commands.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants