Configuring Queries for the api Command

The api command supports using predefined queries, specified via the query parameter. To create or edit a query, navigate to: Main Menu - System Settings - Module Settings - API Queries:

To create a new query, click Create API Query in the top-right corner. To edit an existing query, select it from the list. Below is an example configuration for an API query named json_query:

info

The Request URL field accepts either: a complete absolute URL. A relative path (in which case the host is taken from the API connection settings and combined with the query path).

Click Save to make the query available for use in api commands.

Command execution example

api connection=json-connection query=json-connection