---
title: "Konnect Search"
url: "https://nov18-dev.movespot.fyi/apis/konnect-search-dev-1/versions/43a10fd2-5298-43cc-abd4-e0bd4176a167"
---

# Konnect Search

OpenAPI specification document.

```json
{"openapi":"3.0.2","info":{"title":"Konnect Search","version":"1.0.0","description":"The search API for Kong Konnect.","contact":{"name":"Kong","url":"https://konghq.com"}},"servers":[{"url":"https://us.api.konghq.com/v1","description":"United-States Production region"},{"url":"https://eu.api.konghq.com/v1","description":"Europe Production region"},{"url":"https://au.api.konghq.com/v1","description":"Australia Production region"},{"url":"https://me.api.konghq.com/v1","description":"Middle-East Production region"},{"url":"https://in.api.konghq.com/v1","description":"India Production region"},{"url":"https://sg.api.konghq.com/v1","description":"Singapore Production region"},{"url":"https://global.api.konghq.com/v1","description":"Global Production"}],"paths":{"/search":{"get":{"operationId":"get-search","summary":"List Konnect Entities via Search","description":"Retrieves a list of Konnect entities matching the search query provided.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"},{"name":"q","in":"query","description":"The query that defines the search criteria. Supports Lucene-like syntax for filtering results. Learn more about search query syntax [here](https://docs.konghq.com/konnect/reference/search).\n","required":true,"schema":{"type":"string"},"example":"name:\"John Smith\""},{"name":"mode","in":"query","required":false,"schema":{"$ref":"#/components/schemas/SearchMode"}}],"responses":{"200":{"$ref":"#/components/responses/SearchResponse"},"400":{"$ref":"#/components/responses/SearchBadRequest"}},"tags":["Search"]},"post":{"operationId":"post-search","summary":"Search Konnect","description":"Retrieves a list of Konnect entities matching the search query provided.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"}],"requestBody":{"$ref":"#/components/requestBodies/SearchRequest"},"responses":{"200":{"$ref":"#/components/responses/PostSearchResponse"},"400":{"$ref":"#/components/responses/SearchBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"externalDocs":{"description":"Learn more about search query syntax.","url":"https://docs.konghq.com/konnect/reference/search"},"tags":["Search"]}},"/search/analytics":{"post":{"operationId":"post-search-analytics","summary":"Search Konnect Analytics","description":"Retrieves a list of Konnect entities matching the search query provided. It requires `reports#list` permission.","parameters":[{"$ref":"#/components/parameters/PageSize"},{"$ref":"#/components/parameters/PageAfter"}],"requestBody":{"$ref":"#/components/requestBodies/AnalyticsSearchRequest"},"responses":{"200":{"$ref":"#/components/responses/AnalyticsSearchResponse"},"400":{"$ref":"#/components/responses/SearchBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"externalDocs":{"description":"Learn more about search query syntax.","url":"https://docs.konghq.com/konnect/reference/search"},"tags":["Search"]}},"/internal/aggregations/platform":{"post":{"operationId":"post-search-aggregations-platform","summary":"Aggregate platform entity counts","description":"Returns aggregated entity counts for a Konnect org. Called by kAnalytics only.\nkSearch owns all OpenSearch DSL construction internally.\n","requestBody":{"$ref":"#/components/requestBodies/PlatformAggregateRequest"},"responses":{"200":{"$ref":"#/components/responses/PlatformAggregateResponse"},"400":{"$ref":"#/components/responses/PlatformAggregateBadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"403":{"$ref":"#/components/responses/Forbidden"},"404":{"$ref":"#/components/responses/NotFound"}},"tags":["Search"]}}},"components":{"parameters":{"PageAfter":{"name":"page[after]","description":"Request the next page of data, starting with the item after this parameter.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"string","example":"ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ"}},"PageSize":{"name":"page[size]","description":"The maximum number of items to include per page. The last page of a collection may include fewer items.","required":false,"in":"query","allowEmptyValue":true,"schema":{"type":"integer","example":10}}},"schemas":{"SearchCursorMeta":{"description":"Pagination metadata.","type":"object","properties":{"page":{"$ref":"#/components/schemas/SearchCursorMetaPage"}},"required":["page"]},"SearchCursorMetaPage":{"type":"object","properties":{"next":{"description":"URI to the next page","type":"string","format":"path","nullable":true},"size":{"description":"Requested page size","type":"number","example":10}},"required":["size"]},"SearchResponse":{"description":"Search response schema.","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SearchResultItem"}},"meta":{"$ref":"#/components/schemas/SearchCursorMeta"}},"title":"SearchResponse"},"SearchResultItem":{"description":"Item included in the list of search results.","type":"object","properties":{"id":{"description":"Unique identifier for the record.","type":"string"},"type":{"description":"Konnect entity type.","type":"string"},"name":{"description":"Name of the entity.","type":"string"},"description":{"description":"Description of the entity.","type":"string"},"labels":{"description":"Labels for the entity.","type":"object"},"relations":{"description":"Relations for the entity.","type":"object"},"attributes":{"description":"Attributes for the entity.","type":"object"},"match":{"description":"The matched text from the record.","type":"string"},"relations_list":{"description":"The relations tree with child and sibling relations.","type":"array","items":{"$ref":"#/components/schemas/Relation"},"nullable":true}},"required":["id","type","name"],"title":"SearchResultItem"},"AnalyticsSearchPayload":{"description":"Analytics search request payload","oneOf":[{"$ref":"#/components/schemas/AnalyticsSearchPayloadQueryRequest"},{"$ref":"#/components/schemas/AnalyticsSearchPayloadBulkLookupRequest"}],"title":"AnalyticsSearchPayload"},"AnalyticsSearchPayloadQueryRequest":{"type":"object","properties":{"query":{"description":"The query that defines the search criteria. Supports Lucene-like syntax for filtering results. Learn more about search query syntax [here](https://docs.konghq.com/konnect/reference/search).\n","type":"string","example":"type:consumer AND @scope:realm AND id:(abc OR xyz OR 123)"}},"required":["query"]},"AnalyticsSearchPayloadBulkLookupRequest":{"type":"object","properties":{"bulk_lookup":{"$ref":"#/components/schemas/AnalyticsSearchPayloadBulkLookup"}},"required":["bulk_lookup"]},"AnalyticsSearchPayloadBulkLookup":{"description":"Bulk lookup of entities matching the values.","type":"object","properties":{"type":{"description":"The entity type.","type":"string"},"filters":{"description":"The values to lookup.","type":"array","items":{"type":"object","additionalProperties":{"type":"string"}},"maxItems":1000,"minItems":1}},"required":["type","filters"],"title":"AnalyticsSearchPayloadBulkLookup"},"SearchPayload":{"description":"Search request payload\nUse **`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.  \nexample: type:consumer AND name:us-control-west2 AND @scope:realm\n\nUse **`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.  \nexample: Retrieve details for a list of known user IDs or system accounts.\n\nOnly one of `query` or `bulk_lookup` should be provided per request.\n","oneOf":[{"$ref":"#/components/schemas/SearchPayloadQueryRequest"},{"$ref":"#/components/schemas/SearchPayloadBulkLookupRequest"}],"title":"SearchPayload"},"SearchPayloadQueryRequest":{"type":"object","properties":{"query":{"description":"The query that defines the search criteria. Supports Lucene-like syntax for filtering results. Learn more about search query syntax [here](https://docs.konghq.com/konnect/reference/search).\n","type":"string","example":"type:consumer AND @scope:realm AND id:(abc OR xyz OR 123)"}},"required":["query"]},"SearchPayloadBulkLookupRequest":{"type":"object","properties":{"bulk_lookup":{"$ref":"#/components/schemas/SearchPayloadBulkLookup"}},"required":["bulk_lookup"]},"SearchPayloadBulkLookup":{"description":"Bulk lookup of entities matching the values.","type":"object","properties":{"type":{"description":"The entity type.","type":"string"},"filters":{"description":"The values to lookup.","type":"array","items":{"type":"object","additionalProperties":{"type":"string"}},"maxItems":1000,"minItems":1}},"required":["type","filters"],"title":"SearchPayloadBulkLookup"},"SearchMode":{"description":"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.\n","type":"string","default":"advanced","enum":["basic","advanced"]},"Relation":{"type":"object","properties":{"type":{"description":"The type of the related entity.","type":"string"},"id":{"description":"The unique identifier of the related entity.","type":"string"},"child_relations":{"description":"The child relations of the related entity.","type":"array","items":{"$ref":"#/components/schemas/Relation"},"nullable":true}},"required":["type","id","child_relations"]},"PlatformAggregateRequest":{"description":"**Pre-release Feature**\nThis feature is currently in beta and is subject to change.","type":"object","properties":{"entity_types":{"description":"Entity types to count. When `group_by` is set, only one entity type is allowed.","type":"array","items":{"type":"string","enum":["control_plane","gateway_service","route","consumer","plugin","data_plane_node"]},"minItems":1},"query_type":{"description":"Optional. When omitted, returns current counts only (no comparison or time bucketing).\nWhen `trend`, `start` and `end` are required. When `time_series`, `start`, `end`, and `interval` are required.\n","type":"string","enum":["trend","time_series"]},"start":{"description":"Start of the time range (inclusive). Required when query_type is set. ISO 8601 UTC datetime.","type":"string","format":"date-time","example":"2026-02-21T00:00:00.000Z"},"end":{"description":"End of the time range (inclusive). Required when query_type is set. ISO 8601 UTC datetime.","type":"string","format":"date-time","example":"2026-03-23T00:00:00.000Z"},"interval":{"description":"Bucket interval. Required when query_type=time_series.","type":"string","enum":["1d","1w","1M","1q","1y"]},"group_by":{"description":"Dimension to group results by. Available dimensions depend on entity_type:\ncontrol_plane → (none), gateway_service → control_plane,\nroute → control_plane | gateway_service,\nconsumer → control_plane | realm,\nplugin → control_plane | plugin_name | plugin_scope,\ndata_plane_node → control_plane | data_plane_node_version.\n","type":"string","enum":["control_plane","gateway_service","realm","plugin_name","plugin_scope","data_plane_node_version"]},"filters":{"description":"Optional filters. Dimensions available for filtering match those available for group_by.","type":"array","items":{"$ref":"#/components/schemas/PlatformAggregateFilter"}}},"required":["entity_types"]},"PlatformAggregateFilter":{"type":"object","properties":{"dimension":{"type":"string","enum":["control_plane","gateway_service","realm","plugin_name","plugin_scope","data_plane_node_version"]},"operator":{"type":"string","enum":["in","not_in","is_empty","is_not_empty"]},"value":{"description":"Required for `in` and `not_in`. Not used for `is_empty`/`is_not_empty`.","type":"array","items":{"type":"string"}}},"required":["dimension","operator"]},"PlatformAggregateResponse":{"type":"object","properties":{"data":{"description":"Array of CountResult (no query_type), TrendResult (trend), or TimeSeriesResult (time_series).\n","oneOf":[{"type":"array","items":{"$ref":"#/components/schemas/PlatformCountResult"}},{"type":"array","items":{"$ref":"#/components/schemas/PlatformTrendResult"}},{"type":"array","items":{"$ref":"#/components/schemas/PlatformTimeSeriesResult"}}]}},"required":["data"]},"PlatformCountResult":{"description":"Current count for an entity type. Returned when query_type is omitted.","type":"object","properties":{"entity_type":{"type":"string"},"group_value":{"description":"Present when group_by is specified.","type":"string"},"count":{"type":"integer","example":24}},"required":["entity_type","count"]},"PlatformTrendResult":{"description":"Current vs previous count for an entity type. Returned when query_type=trend.","type":"object","properties":{"entity_type":{"type":"string"},"group_value":{"description":"Present when group_by is specified.","type":"string"},"current_count":{"type":"integer","example":24},"previous_count":{"type":"integer","example":20}},"required":["entity_type","current_count","previous_count"]},"PlatformTimeSeriesResult":{"description":"Cumulative count of entities as of each time bucket. Returned when query_type=time_series.","type":"object","properties":{"timestamp":{"type":"string","format":"date-time","example":"2026-01-04T00:00:00.000Z"},"group_value":{"description":"Present when group_by is specified.","type":"string"},"count":{"description":"Total number of entities existing as of the end of this time bucket.","type":"integer","example":11}},"required":["timestamp","count"]},"BaseError":{"description":"standard error","type":"object","properties":{"status":{"description":"The HTTP status code of the error. Useful when passing the response\nbody to child properties in a frontend UI. Must be returned as an integer.\n","type":"integer","readOnly":true},"title":{"description":"A short, human-readable summary of the problem. It should not\nchange between occurences of a problem, except for localization.\nShould be provided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true},"type":{"description":"The error type.","type":"string","readOnly":true},"instance":{"description":"Used to return the correlation ID back to the user, in the format\nkong:trace:<correlation_id>. This helps us find the relevant logs\nwhen a customer reports an issue.\n","type":"string","readOnly":true},"detail":{"description":"A human readable explanation specific to this occurence of the problem.\nThis field may contain request/entity data to help the user understand\nwhat went wrong. Enclose variable values in square brackets. Should be\nprovided as \"Sentence case\" for direct use in the UI.\n","type":"string","readOnly":true}},"required":["status","title","instance","detail"],"title":"Error"},"InvalidRules":{"description":"invalid parameters rules","type":"string","enum":["required","is_array","is_base64","is_boolean","is_date_time","is_integer","is_null","is_number","is_object","is_string","is_uuid","is_fqdn","is_arn","unknown_property","missing_reference","is_label","matches_regex","invalid","is_supported_network_availability_zone_list","is_supported_network_cidr_block","is_supported_provider_region","type"],"nullable":true,"readOnly":true},"InvalidParameterStandard":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"$ref":"#/components/schemas/InvalidRules"},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"is a required field","readOnly":true}},"additionalProperties":false,"required":["field","reason"]},"InvalidParameterMinimumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["min_length","min_digits","min_lowercase","min_uppercase","min_symbols","min_items","min"],"nullable":false,"readOnly":true},"minimum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must have at least 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","minimum"]},"InvalidParameterMaximumLength":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["max_length","max_items","max"],"nullable":false,"readOnly":true},"maximum":{"type":"integer","example":8},"source":{"type":"string","example":"body"},"reason":{"type":"string","example":"must not have more than 8 characters","readOnly":true}},"additionalProperties":false,"required":["field","reason","rule","maximum"]},"InvalidParameterChoiceItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["enum"],"nullable":false,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"choices":{"type":"array","items":{},"minItems":1,"nullable":false,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","reason","rule","choices"]},"InvalidParameterDependentItem":{"type":"object","properties":{"field":{"type":"string","example":"name","readOnly":true},"rule":{"description":"invalid parameters rules","type":"string","enum":["dependent_fields"],"nullable":true,"readOnly":true},"reason":{"type":"string","example":"is a required field","readOnly":true},"dependents":{"type":"array","items":{},"nullable":true,"readOnly":true,"uniqueItems":true},"source":{"type":"string","example":"body"}},"additionalProperties":false,"required":["field","rule","reason","dependents"]},"InvalidParameters":{"description":"invalid parameters","type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/InvalidParameterStandard"},{"$ref":"#/components/schemas/InvalidParameterMinimumLength"},{"$ref":"#/components/schemas/InvalidParameterMaximumLength"},{"$ref":"#/components/schemas/InvalidParameterChoiceItem"},{"$ref":"#/components/schemas/InvalidParameterDependentItem"}]},"minItems":1,"nullable":false,"uniqueItems":true},"BadRequestError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","required":["invalid_parameters"],"properties":{"invalid_parameters":{"$ref":"#/components/schemas/InvalidParameters"}}}]},"UnauthorizedError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":401},"title":{"example":"Unauthorized"},"type":{"example":"https://httpstatuses.com/401"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Invalid credentials"}}}]},"ForbiddenError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":403},"title":{"example":"Forbidden"},"type":{"example":"https://httpstatuses.com/403"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Forbidden"}}}]},"NotFoundError":{"allOf":[{"$ref":"#/components/schemas/BaseError"},{"type":"object","properties":{"status":{"example":404},"title":{"example":"Not Found"},"type":{"example":"https://httpstatuses.com/404"},"instance":{"example":"kong:trace:1234567890"},"detail":{"example":"Not found"}}}]}},"examples":{"400-query-is-invalid":{"value":{"status":400,"title":"Bad Request","detail":"Invalid query.","instance":"konnect:trace:3674017986744198214","invalid_parameters":[{"field":"q","reason":"invalid query","source":"query"}]}},"Successful-Search-Example":{"value":{"data":[{"id":"c0010105-e840-4824-b7ee-787f22267c36","type":"team","name":"Sonar Readings","labels":{"env":"prod"},"attributes":{"created_at":"2022-07-31T09:15:15.04Z","updated_at":"2023-02-11T18:47:03.34Z"}},{"id":"c0010105-e840-4824-b7ee-787f22267c37","type":"user","name":"Jason Developer","attributes":{"created_at":"2023-01-16T00:21:01.68Z","email":"jason.developer@test.com","preferred_name":"","updated_at":"2023-09-08T22:39:51.53Z"}},{"id":"c0010105-e840-4824-b7ee-787f22267c38","type":"user","name":"Sonia Engineer","attributes":{"created_at":"2023-07-19T00:00:00.00Z","email":"sonia.engineer@test.com","preferred_name":"","updated_at":"2023-07-19T00:00:00.00Z"}},{"id":"c0010105-e840-4824-b7ee-787f22267c39","type":"system_account","name":"System Account 1","attributes":{"created_at":"2023-05-10T12:00:00.00Z","updated_at":"2023-05-10T12:00:00.00Z"},"relations_list":[{"type":"system_account","id":"c0010105-e840-4824-b7ee-787f22267c39","child_relations":[{"type":"api_product","id":"ap0010105-e840-4824-b7ee-787f22267c40"}]},{"type":"api_product","id":"ap0010105-e840-4824-b7ee-787f22267c41","child_relations":[{"type":"system_account","id":"c0010105-e840-4824-b7ee-787f22267c42"},{"type":"system_account","id":"c0010105-e840-4824-b7ee-787f22267c43"},{"type":"system_account","id":"c0010105-e840-4824-b7ee-787f22267c44"}]},{"type":"system_account","id":"c0010105-e840-4824-b7ee-787f22267c45"}]}],"meta":{"page":{"size":3,"next":"/search?q=son&page[after]=ewogICJpZCI6ICJoZWysbyB3b3JsZCIKgZ"}}}},"AnalyticsSearchResponseSuccess":{"value":{"data":[{"id":"c0010105-e840-4824-b7ee-787f22267c36","type":"consumer","name":"example-consumer-1","description":"example consumer 1","labels":{"env":"prod"},"attributes":{"username":"example-consumer-1","custom_id":"example-consumer-1","created_at":"2022-07-31T09:15:15.04Z","updated_at":"2023-02-11T18:47:03.34Z"},"relations":{"control_plane_id":"060e479c-166c-4921-a22c-49a24bbb2c63"}},{"id":"c0010105-e840-4824-b7ee-787f22267c37","type":"consumer","name":"example-consumer-2","description":"example consumer 2","attributes":{"username":"example-consumer-2","custom_id":"example-consumer-2","created_at":"2022-07-31T09:15:15.04Z","updated_at":"2023-02-11T18:47:03.34Z"},"relations":{"control_plane_id":"060e479c-166c-4921-a22c-49a24bbb2c64"}},{"id":"c0010105-e840-4824-b7ee-787f22267c38","type":"consumer","name":"example-consumer-3","description":"example consumer 3","attributes":{"username":"example-consumer-3","custom_id":"example-consumer-3","created_at":"2022-07-31T09:15:15.04Z","updated_at":"2023-02-11T18:47:03.34Z"},"relations":{"control_plane_id":"060e479c-166c-4921-a22c-49a24bbb2c65"}}],"meta":{"page":{"size":3,"next":"/search?q=son&page[after]=ewogICJpZCI6ICJoZWysbyB3b3JsZCIKgZ"}}}},"PostSearchResponseSuccess":{"value":{"data":[{"id":"c0010105-e840-4824-b7ee-787f22267c36","type":"consumer","name":"example-consumer-1","description":"example consumer 1","labels":{"env":"prod"},"attributes":{"username":"example-consumer-1","custom_id":"example-consumer-1","created_at":"2022-07-31T09:15:15.04Z","updated_at":"2023-02-11T18:47:03.34Z"},"relations":{"control_plane_id":"060e479c-166c-4921-a22c-49a24bbb2c63"}},{"id":"c0010105-e840-4824-b7ee-787f22267c37","type":"consumer","name":"example-consumer-2","description":"example consumer 2","attributes":{"username":"example-consumer-2","custom_id":"example-consumer-2","created_at":"2022-07-31T09:15:15.04Z","updated_at":"2023-02-11T18:47:03.34Z"},"relations":{"control_plane_id":"060e479c-166c-4921-a22c-49a24bbb2c64"}},{"id":"c0010105-e840-4824-b7ee-787f22267c38","type":"consumer","name":"example-consumer-3","description":"example consumer 3","attributes":{"username":"example-consumer-3","custom_id":"example-consumer-3","created_at":"2022-07-31T09:15:15.04Z","updated_at":"2023-02-11T18:47:03.34Z"},"relations":{"control_plane_id":"060e479c-166c-4921-a22c-49a24bbb2c65"}}],"meta":{"page":{"size":3,"next":"/search?q=son&page[after]=ewogICJpZCI6ICJoZWysbyB3b3JsZCIKgZ"}}}},"AnalyticsSearchRequestExample":{"value":{"query":"type:consumer AND @scope:realm AND id:(abc OR xyz OR 123)"}},"AnalyticsSearchRequestExample2":{"value":{"bulk_lookup":{"type":"consumer","filters":[{"id":"id-1","relations.control_plane_id":"060e479c-166c-4921-a22c-49a24bbb2c63"},{"id":"id-2","name":"name-2","relations.control_plane_id":"060e479c-166c-4921-a22c-49a24bbb2c64"},{"id":"id-3","attributes.custom_id":"custom-id-3","attributes.realm_id":"realm-123"}]}}},"SearchRequestExample":{"value":{"query":"type:consumer AND @scope:realm AND id:(abc OR xyz OR 123)"}},"SearchRequestExample2":{"value":{"bulk_lookup":{"type":"consumer","filters":[{"id":"id-1","relations.control_plane_id":"060e479c-166c-4921-a22c-49a24bbb2c63"},{"id":"id-2","name":"name-2","relations.control_plane_id":"060e479c-166c-4921-a22c-49a24bbb2c64"},{"id":"id-3","attributes.custom_id":"custom-id-3","attributes.realm_id":"realm-123"}]}}},"UnauthorizedExample":{"value":{"status":401,"title":"Unauthorized","instance":"kong:trace:8347343766220159418","detail":"Unauthorized"}},"ForbiddenExample":{"value":{"status":403,"title":"Forbidden","instance":"kong:trace:2723154947768991354","detail":"You do not have permission to perform this action"}},"NotFoundExample":{"value":{"status":404,"title":"Not Found","instance":"kong:trace:6816496025408232265","detail":"Not Found"}}},"requestBodies":{"PlatformAggregateRequest":{"description":"Platform aggregation request payload","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformAggregateRequest"},"examples":{"Count only (current totals)":{"value":{"entity_types":["control_plane","gateway_service","route","consumer","plugin"]}},"Trend (stats grid)":{"value":{"entity_types":["control_plane","gateway_service","route","consumer","plugin"],"query_type":"trend","start":"2026-02-21T00:00:00.000Z","end":"2026-03-23T00:00:00.000Z"}},"Time series (weekly CP trend)":{"value":{"entity_types":["control_plane"],"query_type":"time_series","start":"2026-02-21T00:00:00.000Z","end":"2026-03-23T00:00:00.000Z","interval":"1w"}}}}}},"AnalyticsSearchRequest":{"description":"Analytics search request payload","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AnalyticsSearchPayload"},"examples":{"Search Request Example Query":{"$ref":"#/components/examples/AnalyticsSearchRequestExample"},"Search Request Example Bulk Lookup":{"$ref":"#/components/examples/AnalyticsSearchRequestExample2"}}}}},"SearchRequest":{"description":"Search request payload","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchPayload"},"examples":{"Search Request Example Query":{"$ref":"#/components/examples/SearchRequestExample"},"Search Request Example Bulk Lookup":{"$ref":"#/components/examples/SearchRequestExample2"}}}}}},"responses":{"SearchResponse":{"description":"Search response for containing all matched Konnect entities.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"},"examples":{"Successful Search Response":{"$ref":"#/components/examples/Successful-Search-Example"}}}}},"SearchBadRequest":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"},"examples":{"Request Format is Invalid":{"$ref":"#/components/examples/400-query-is-invalid"}}}}},"AnalyticsSearchResponse":{"description":"Search response for containing all matched Konnect entities.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"},"examples":{"Successful Search Response":{"$ref":"#/components/examples/AnalyticsSearchResponseSuccess"}}}}},"PostSearchResponse":{"description":"Search response for containing all matched Konnect entities.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResponse"},"examples":{"Successful Search Response":{"$ref":"#/components/examples/PostSearchResponseSuccess"}}}}},"PlatformAggregateResponse":{"description":"Aggregation results.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlatformAggregateResponse"}}}},"PlatformAggregateBadRequest":{"description":"Bad Request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/BadRequestError"}}}},"Unauthorized":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/UnauthorizedExample"}}}}},"Forbidden":{"description":"Forbidden","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"},"examples":{"UnauthorizedExample":{"$ref":"#/components/examples/ForbiddenExample"}}}}},"NotFound":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/NotFoundError"},"examples":{"NotFoundExample":{"$ref":"#/components/examples/NotFoundExample"}}}}}},"securitySchemes":{"systemAccountAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Token","description":"The system account access token is meant for automations and integrations that are not directly associated with a human identity.\nYou can generate a system account Access Token by creating a system account and then obtaining a system account access token for that account.\nThe access token must be passed in the header of a request, for example:\n`curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'`\n"},"personalAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"Token","description":"The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs.\nYou can generate a Personal Access Token (PAT) from the [personal access token page](https://cloud.konghq.com/global/account/tokens/) in the Konnect dashboard.\nThe PAT token must be passed in the header of a request, for example:\n`curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT...'`\n"},"konnectAccessToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT","description":"The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI authenticate with.\n"}}},"tags":[{"name":"Search"}],"security":[{"personalAccessToken":[]},{"systemAccountAccessToken":[]},{"konnectAccessToken":[]}]}
```
