versions

The API for Konnect Portal Product Versions.

Get page of product versions

Returns paginated list of versions of a given product.

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

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

Path Parameters

productIdstring(uuid)required

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

Response

application/json

Paginated list of versions of an API Product.

ProductVersionListPage

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

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

Get product version

Gets the details for an existing product version.

get
/api/v2/products/{productId}/versions/{productVersionId}

Path Parameters

productIdstring(uuid)required

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

productVersionIdstring(uuid)required

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

Response

application/json

Product version details.

ProductVersion

* 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 version.

Example:v2.0.0

deprecatedbooleanrequired

If true, product version is deprecated.

registration_configsarray[object]required

Configurations for how the product version is able to be registered for by applications.

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

Get applications by product version

Get applications that have a registration for a given product version. Any registration for the version will count, regardless of status (i.e. even if it is pending, rejected, or revoked).
Use the unregistered query param to return the inverse, only including applicatons that do not have a registration (regardless of status).

get
/api/v2/products/{productId}/versions/{productVersionId}/applications

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[status][eq]string

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

Allowed values:approvedpendingrejectedrevoked

Example:approved

filter[status]string

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

Allowed values:approvedpendingrejectedrevoked

Example:approved

filter[auth_strategy_id][eq]string

Filter by the id of the auth strategy supported by the application.

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

filter[auth_strategy_id]string

Filter by the id of the auth strategy supported by the application (short-hand).

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

unregisteredboolean

Return applications that do not have a registration for the product version (regardless of registration status).

Path Parameters

productIdstring(uuid)required

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

productVersionIdstring(uuid)required

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

Response

application/json

Paginated list of applications either registered or not registered for a product version.

ProductVersionListApplicationsPage

* Additional properties are NOT allowed.
metaobjectrequired

returns the pagination information

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

Get spec for product version

Returns the API specification document attached to given product version. Currently only OpenAPI is supported.

get
/api/v2/products/{productId}/versions/{productVersionId}/spec

Path Parameters

productIdstring(uuid)required

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

productVersionIdstring(uuid)required

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

Response

application/json

Product version spec document.

ProductVersionSpecDocument

API specification document for a product version.

api_typestringrequired

Allowed values:openapi

contentstringrequired
application/json