Skip to content
Kong Docs are moving soon! Our docs are migrating to a new home. You'll be automatically redirected to the new site in the future. In the meantime, view this page on the new site!
|

Konnect Search

v1.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

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

Search Konnect

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.

Example:name:"John Smith"

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
  
curl --request GET \
  --url 'https://us.api.konghq.com/v1/search?page=&q=name%3A%22John%20Smith%22' \
  --header 'Accept: application/json, application/problem+json' \
  --header 'Authorization: Bearer ' \
  --header 'Content-Type: application/json'
application/json
{
  "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"
      }
    }
  ],
  "meta": {
    "page": {
      "size": 3,
      "next": "/search?q=son&page[after]=ewogICJpZCI6ICJoZWysbyB3b3JsZCIKgZ"
    }
  }
}