2.0.0OAS 3.0

N/A (this description is removed during bundling)

API Base URL
Security
portalAccessToken (apiKey)

The Developer portal cookie is meant to be used by the Developer API to authenticate with.

Additional Information
Contact Kong

List Portal Entities via Search

Returns paginated search results from the specified entities with the given search parameters.

get
/api/v2/search/{indices}

Query Parameters

qstring

Determines how to filter search results

joinstring

Accepted values are versions and versions.documents. Use commas to separate multiple values.

Example:versions,versions.documents

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[number]integer

Determines which page of the entities to retrieve.

Example:1

Path Parameters

indicesstringrequired

Determines which entity sets to search

Allowed values:product-catalog

Response

application/json

Search Results

SearchResults

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

The paginated results that matched the search query

* Additional properties are NOT allowed.
Show Child Parameters
application/json