products

The API for Konnect Portal Products.

Get a product

Gets the details for an existing published product.

get
/api/v2/products/{productId}

Path Parameters

productIdstring(uuid)required

Contains a unique identifier used by the Portal API for this resource.

Response

application/json

Response for a single product’s details.

Product

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

namestringrequired

Name of product.

Example:Billing

descriptionstring | null

Example:API for billing functions

document_countintegerread-only

Number of linked documents in documentation.

Example:3

version_countintegerread-only

Number of published versions.

Example:2

latest_versionobject | null
* Additional properties are NOT allowed.
Show Child Parameters
public_labelsobjectrequired

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

application/json

List Products

Returns a paginated list of published API Products.

get
/api/v2/products

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

Determines which page of the entities to retrieve.

Example:1

filter[name][eq]string

Filter by direct equality comparison of the name property with a supplied value.

Example:good service

filter[name]string

Filter by direct equality comparison (short-hand) of the name property with a supplied value.

Example:good service

filter[name][contains]string

Filter by contains comparison of the name property with a supplied substring

Example:good service

filter[description][eq]string

Filter by direct equality comparison of the description property with a supplied value.

Example:portal

filter[description]string

Filter by direct equality comparison (short-hand) of the description property with a supplied value.

Example:portal

filter[description][contains]string

Filter by contains comparison of the description property with a supplied substring

Example:portal

filter[id][eq]string

Filter by direct equality comparison of the id property with a supplied value.

Example:5be86298-147b-45ab-bfaf-a1bff97dce39

filter[id]string

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 for a list of products.

ProductListPage

metaobject

returns the pagination information

Show Child Parameters
dataarray[object]
* Additional properties are NOT allowed.
Show Child Parameters
application/json

Get Product Actions

Get a list of actions that the current developer is allowed to perform on an API product.

get
/api/v2/products/{productId}/actions

Path Parameters

productIdstring(uuid)required

Contains a unique identifier used by the Portal API for this resource.

Response

application/json

Product actions

Product Actions Response

* Additional properties are NOT allowed.
actionsobjectrequired

List of actions that can be performed on the API Product

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

versions

The API for Konnect Portal Product Versions.