Get a product
Gets the details for an existing published product.
Path Parameters
Contains a unique identifier used by the Portal API for this resource.
Response
application/json
Response
Response for a single product’s details.
Product
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z
Name of product.
Example:Billing
Example:API for billing functions
Number of linked documents in documentation.
Example:3
Number of published versions.
Example:2
Show Child Parameters
Public labels store information about an entity that can be used for filtering a list of objects.
Public labels are intended to store PUBLIC metadata.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
Example:{"category":"finance"}
List Products
Returns a paginated list of published API Products.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Filter by direct equality comparison of the name property with a supplied value.
Example:good service
Filter by direct equality comparison (short-hand) of the name property with a supplied value.
Example:good service
Filter by contains comparison of the name property with a supplied substring
Example:good service
Filter by direct equality comparison of the description property with a supplied value.
Example:portal
Filter by direct equality comparison (short-hand) of the description property with a supplied value.
Example:portal
Filter by contains comparison of the description property with a supplied substring
Example:portal
Filter by direct equality comparison of the id property with a supplied value.
Example:5be86298-147b-45ab-bfaf-a1bff97dce39
Filter by direct equality comparison (short-hand) of the id property with a supplied value.
Example:5be86298-147b-45ab-bfaf-a1bff97dce39
Response
application/json
Response
Response for a list of products.
ProductListPage
returns the pagination information
Show Child Parameters
Show Child Parameters
Get Product Actions
Get a list of actions that the current developer is allowed to perform on an API product.
Path Parameters
Contains a unique identifier used by the Portal API for this resource.
Response
application/json
Response
Product actions
Product Actions Response
List of actions that can be performed on the API Product
Show Child Parameters
versions
The API for Konnect Portal Product Versions.
Get page of product versions
Returns paginated list of versions of a given product.
Query Parameters
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
Filter by direct equality comparison of the name property with a supplied value.
Example:good service
Filter by direct equality comparison (short-hand) of the name property with a supplied value.
Example:good service
Filter by contains comparison of the name property with a supplied substring
Example:good service
Path Parameters
Contains a unique identifier used by the Portal API for this resource.
Response
application/json
Response
Paginated list of versions of an API Product.
ProductVersionListPage
returns the pagination information