MediaWiki API help
This is an auto-generated MediaWiki API documentation page.
Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=streamconfigs
(main | streamconfigs)
- This module requires read rights.
- Source: EventStreamConfig
- License: GPL-2.0-or-later
Exposes event stream config. Returns only format=json with formatversion=2.
Specific parameters:
Other general parameters are available.
- streams
List of streams to get config for
- Separate values with | or alternative.
- Maximum number of values is २५० (५०० for clients that are allowed higher limits).
- constraints
Filter results for stream config entries that have these settings
- Separate values with | or alternative.
- Maximum number of values is ५० (५०० for clients that are allowed higher limits).
- all_settings
- Deprecated.
Include all settings in stream config results. Deprecated since 1.41. All settings are included by default.
- Type: boolean (details)
Examples:
- Get stream configs for a list of streams
- api.php?action=streamconfigs&streams=mediawiki.page-view|mediawiki.button-click [open in sandbox]
- Get stream config for streams with all settings
- api.php?action=streamconfigs&streams=mediawiki.button-click [open in sandbox]
- Get stream config for streams that have settings matching these constraints
- api.php?action=streamconfigs&streams=mediawiki.button-click&constraints=event_service_name=eventgate-main [open in sandbox]