1.0.0OAS 3.0

The search API for Kong Konnect.

API Base URL
  • Server 1:https://us.api.konghq.com/v1

    United-States Production region

  • Server 2:https://eu.api.konghq.com/v1

    Europe Production region

  • Server 3:https://au.api.konghq.com/v1

    Australia Production region

  • Server 4:https://me.api.konghq.com/v1

    Middle-East Production region

  • Server 5:https://in.api.konghq.com/v1

    India Production region

  • Server 6:https://sg.api.konghq.com/v1

    Singapore Production region

  • Server 7:https://global.api.konghq.com/v1

    Global Production

Security
systemAccountAccessToken (http)

The system account access token is meant for automations and integrations that are not directly associated with a human identity.
You can generate a system account Access Token by creating a system account and then obtaining a system account access token for that account.
The access token must be passed in the header of a request, for example:
curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer spat_i2Ej...'

personalAccessToken (http)

The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs.
You can generate a Personal Access Token (PAT) from the personal access token page in the Konnect dashboard.
The PAT token must be passed in the header of a request, for example:
curl -X GET 'https://global.api.konghq.com/v2/users/' --header 'Authorization: Bearer kpat_xgfT...'

konnectAccessToken (http)

The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI authenticate with.

Additional Information
Contact Kong

List Konnect Entities via Search

Retrieves a list of Konnect entities matching the search query provided.

get

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

qstringrequired

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"

modestring

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

Search response for containing all matched Konnect entities.

SearchResponse

Search response schema.

dataarray[object]

Item included in the list of search results.

Show Child Parameters
metaobject

Pagination metadata.

Show Child Parameters
get/search
 
application/json

Search Konnect

Retrieves a list of Konnect entities matching the search query provided.

post

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

Body

application/json

Search request payload

SearchPayload

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 Of
querystringrequired

The 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

Search response for containing all matched Konnect entities.

SearchResponse

Search response schema.

dataarray[object]

Item included in the list of search results.

Show Child Parameters
metaobject

Pagination metadata.

Show Child Parameters
post/search

Body

{ "query": "type:consumer AND @scope:realm AND id:(abc OR xyz OR 123)" }
 
application/json

Search Konnect Analytics

Retrieves a list of Konnect entities matching the search query provided. It requires reports#list permission.

post

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[after]string

Request the next page of data, starting with the item after this parameter.

Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ

Body

application/json

Analytics search request payload

AnalyticsSearchPayload

AnalyticsSearchPayload

Analytics search request payload

One Of
querystringrequired

The 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

Search response for containing all matched Konnect entities.

SearchResponse

Search response schema.

dataarray[object]

Item included in the list of search results.

Show Child Parameters
metaobject

Pagination metadata.

Show Child Parameters
post/search/analytics

Body

{ "query": "type:consumer AND @scope:realm AND id:(abc OR xyz OR 123)" }
 
application/json