Konnect Search (1.0.0)

Download OpenAPI specification:Download

URL: https://konghq.com

The search API for Kong Konnect.

Search

Search Konnect

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

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

query Parameters

page[size]	integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items.
page[after]	string Example: page[after]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ Request the next page of data, starting with the item after this parameter.
q required	string Example: q=name:"John Smith" The query that defines the search criteria. Supports Lucene-like syntax for filtering results. Learn more about search query syntax here.

Responses

Response samples

200
400

Content type

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"
}
}
}

List Search Types

Retrieves a list of searchable Konnect entity types.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

Responses

United-States Production region

https://us.api.konghq.com/v1/search/types

Europe Production region

https://eu.api.konghq.com/v1/search/types

Australia Production region

https://au.api.konghq.com/v1/search/types

Middle-East Production region

https://me.api.konghq.com/v1/search/types

India Production region

https://in.api.konghq.com/v1/search/types

Global Production

https://global.api.konghq.com/v1/search/types

Response samples

200

Content type

application/json

{"data": [{"type": "user",
"name": "User",
"description": "A Konnect user",
"attributes": {"created_at": {"type": "string",
"format": "date-time",
"name": "Created At",
"description": "The time the user was created"
},
"preferred_name": {"type": "string",
"name": "Preferred Name",
"description": "The user's preferred name"
},
"email": {"type": "string",
"format": "email",
"name": "Email",
"description": "The user's email address"
}
},
"regions": ["global"
]
},
{"type": "system_account",
"name": "System Account",
"description": "A Konnect system account",
"attributes": {"konnect_managed": {"type": "boolean",
"name": "Konnect Managed",
"description": "Whether the system account is managed by Konnect"
}
},
"regions": ["global"
]
},
{"type": "api_product",
"name": "API Product",
"description": "A Konnect API Product",
"regions": ["us",
"eu",
"au"
]
}
]
}

Search Konnect Analytics

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

Learn more about search query syntax.

Authorizations:

personalAccessTokensystemAccountAccessTokenkonnectAccessToken

query Parameters

page[size]	integer Example: page[size]=10 The maximum number of items to include per page. The last page of a collection may include fewer items.
page[after]	string Example: page[after]=ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ Request the next page of data, starting with the item after this parameter.

Request Body schema: application/json

Analytics search request payload

One of

query

required

string

The query that defines the search criteria. Supports Lucene-like syntax for filtering results. Learn more about search query syntax here.

Responses

United-States Production region

https://us.api.konghq.com/v1/search/analytics

Europe Production region

https://eu.api.konghq.com/v1/search/analytics

Australia Production region

https://au.api.konghq.com/v1/search/analytics

Middle-East Production region

https://me.api.konghq.com/v1/search/analytics

India Production region

https://in.api.konghq.com/v1/search/analytics

Global Production

https://global.api.konghq.com/v1/search/analytics

Request samples

Payload

Content type

application/json

Example

Search Request Example Query

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

Response samples

200
400
401
403
404

Content type

application/json

{"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"
}
}
}