Search
List Konnect Entities via Search
Retrieves a list of Konnect entities matching the search query provided.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Request the next page of data, starting with the item after this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
The query that defines the search criteria. Supports Lucene-like syntax for filtering results. Learn more about search query syntax here.
Example:name:"John Smith"
The mode of search to perform. Basic search is a simple keyword search that matches the query against all searchable fields. Advanced search allows lucene-like syntax for filtering results, including logical operators and field-specific searches.
Allowed values:basicadvanced
Default:advanced
Response
application/json
Response
Search response for containing all matched Konnect entities.
SearchResponse
Search response schema.
Item included in the list of search results.
Show Child Parameters
Pagination metadata.
Show Child Parameters
Authentication
Query Parameters
Search Konnect
Retrieves a list of Konnect entities matching the search query provided.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Request the next page of data, starting with the item after this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
Body
application/json
Body
Search request payload
SearchPayload
Search request payload
Use query when you want to search for targeted, full-text or filtered search using Lucene-like syntax. This is ideal for searching across multiple fields, applying logical operators, or when you need advanced filtering capabilities.
example: type:consumer AND name:us-control-west2 AND @scope:realm
Use bulk_lookup when you need to retrieve more entities by a specific set of attribute values, such as a list of IDs or other unique keys.
example: Retrieve details for a list of known user IDs or system accounts.
Only one of query or bulk_lookup should be provided per request.
One OfThe query that defines the search criteria. Supports Lucene-like syntax for filtering results. Learn more about search query syntax here.
Example:type:consumer AND @scope:realm AND id:(abc OR xyz OR 123)
Response
application/json
Response
Search response for containing all matched Konnect entities.
SearchResponse
Search response schema.
Item included in the list of search results.
Show Child Parameters
Pagination metadata.
Show Child Parameters
Authentication
Query Parameters
Body
Search Konnect Analytics
Retrieves a list of Konnect entities matching the search query provided. It requires reports#list permission.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Request the next page of data, starting with the item after this parameter.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
Body
application/json
Body
Analytics search request payload
AnalyticsSearchPayload
Analytics search request payload
One OfThe query that defines the search criteria. Supports Lucene-like syntax for filtering results. Learn more about search query syntax here.
Example:type:consumer AND @scope:realm AND id:(abc OR xyz OR 123)
Response
application/json
Response
Search response for containing all matched Konnect entities.
SearchResponse
Search response schema.
Item included in the list of search results.
Show Child Parameters
Pagination metadata.
Show Child Parameters
Authentication
Query Parameters
Body
Aggregate platform entity counts
Returns aggregated entity counts for a Konnect org. Called by kAnalytics only.
kSearch owns all OpenSearch DSL construction internally.
Body
application/json
Body
Platform aggregation request payload
PlatformAggregateRequest
Pre-release Feature
This feature is currently in beta and is subject to change.
Entity types to count. When group_by is set, only one entity type is allowed.
Allowed values:control_planegateway_servicerouteconsumerplugindata_plane_node
>= 1 items
Optional. When omitted, returns current counts only (no comparison or time bucketing).
When trend, start and end are required. When time_series, start, end, and interval are required.
Allowed values:trendtime_series
Start of the time range (inclusive). Required when query_type is set. ISO 8601 UTC datetime.
Example:2026-02-21T00:00:00.000Z
End of the time range (inclusive). Required when query_type is set. ISO 8601 UTC datetime.
Example:2026-03-23T00:00:00.000Z
Bucket interval. Required when query_type=time_series.
Allowed values:1d1w1M1q1y
Dimension to group results by. Available dimensions depend on entity_type:
control_plane → (none), gateway_service → control_plane,
route → control_plane | gateway_service,
consumer → control_plane | realm,
plugin → control_plane | plugin_name | plugin_scope,
data_plane_node → control_plane | data_plane_node_version.
Allowed values:control_planegateway_servicerealmplugin_nameplugin_scopedata_plane_node_version
Optional filters. Dimensions available for filtering match those available for group_by.
Show Child Parameters
Response
application/json
Response
Aggregation results.
PlatformAggregateResponse
One OfArray of CountResult (no query_type), TrendResult (trend), or TimeSeriesResult (time_series).
Current count for an entity type. Returned when query_type is omitted.