mediamtx/docs/2-usage/19-control-api.md
Alessandro Ros 7ecbe736c6
Some checks failed
code_lint / go (push) Has been cancelled
code_lint / go_mod (push) Has been cancelled
code_lint / docs (push) Has been cancelled
code_lint / api_docs (push) Has been cancelled
code_test / test_64 (push) Has been cancelled
code_test / test_32 (push) Has been cancelled
code_test / test_e2e (push) Has been cancelled
docs: update (#5061)
2025-10-05 18:07:39 +02:00

628 B

Control API

The server can be queried and controlled with an API, that can be enabled by toggling the api parameter in the configuration:

api: yes

To obtain a list of of active paths, run:

curl http://127.0.0.1:9997/v3/paths/list

The control API is documented in the Control API Reference page and in the OpenAPI / Swagger file.

Be aware that by default the Control API is accessible by localhost only; to increase visibility or add authentication, check Authentication.