3.0.4OAS 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 for all entities with the given search parameters.

get
/api/v3/search

Query Parameters

qstring

Determines how to filter search results

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

Response

application/json

Search Results

SearchResults

* Additional properties are NOT allowed.
metaobjectrequired

Pagination metadata.

Show Child Parameters
dataOne Of
arrayrequired

The paginated results that matched the search query

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

SearchResults

object
* Additional properties are NOT allowed.
metaobjectrequired

Pagination metadata.

Show Child Parameters
dataOne Of
arrayrequired

The paginated results that matched the search query

SearchResultOperationobject
* Additional properties are NOT allowed.
Show Child Parameters
Example

SearchResultOperation

object
* Additional properties are NOT allowed.
idstringrequired

Unique identifier for the record.

typestringrequired

Portal entity type.

namestringrequired

Name of the entity.

matchstringrequired

The matched text from the record.

descriptionstringrequired

Description of the entity.

attributesobjectrequired

Attributes for the entity.

* Additional properties are NOT allowed.
Show Child Parameters
relationsobjectrequired

Relations for the entity.

* Additional properties are NOT allowed.
Show Child Parameters
Example