question Re: REST API /controller/search-results query syntax? in Archives of Support Questions (Read Only)

REST API /controller/search-results query syntax?

andrewg — Tue, 21 Apr 2026 12:34:39 GMT

https://nifi.apache.org/docs/nifi-docs/rest-api/index.html

I can pull all of the data about a NiFi data flow using the /controller/search-results api call, but the request section also mentions a 'q' parameter (for query). There was no mention of the query syntax in the doc, however, any pointers? Would like to avoid pulling in a full config every time and parse on a constrained device, if possible.

Re: REST API /controller/search-results query syntax?

mpayne — Thu, 05 Nov 2015 02:30:02 GMT

The 'q' parameter is free-form (though URL encoded since it's part of the URL) and is whatever text you are searching for. For instance, it could be the UUID of a Processor, a Property Name or value, etc. If you search in the UI by typing into the Search field in the top-right corner, this just queries that API with whatever you typed into the Search box as the 'q' parameter.

Re: REST API /controller/search-results query syntax?

andrewg — Thu, 05 Nov 2015 02:31:57 GMT

Thanks Mark, so this is a quick way to search for 'expected' components and get an actual ID handle to work with them next. My use case is programmatic flow control through an API.