Get an API product

Returns an API product.

get

Path Parameters

idstring(uuid)required

API product identifier

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

application/json

API product

API Product

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

The API product ID.

Example:b9e81174-b5bb-4638-a3c3-8afe61a0abf8

namestringrequired

The name of the API product

Example:My Name

descriptionstring | nullrequired

The description of the API product

Example:MyDescription

portal_idsarray[string](uuid)requiredunique-itemsDEPRECATED

The list of portal identifiers which this API product is published to.
This property is deprecated and will be removed in a future version. Use the portals property instead.

>= 0 items

portalsarray[object]required

The list of portals which this API product is published to

>= 0 items

* Additional properties are NOT allowed.
Show Child Parameters
version_countnumberrequired

The number of product versions attached to this API product

Example:10

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

labelsobjectrequired

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

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

get/api-products/{id}
 
application/json

Update an individual API product

Updates an API product.

patch

Path Parameters

idstring(uuid)required

API product identifier

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Body

application/json

Update API Product Request

The request schema for updating an API product.

* Additional properties are NOT allowed.
namestring

The name for the API product.

>= 1 characters<= 100 characters

Example:API Product

descriptionstring | null

The description of the API product.

Example:Text describing the API product

labelsobject | null

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Labels are intended to store INTERNAL metadata.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

public_labelsobject

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

portal_idsarray[string](uuid)unique-items

The list of portal identifiers which this API product should be published to

>= 0 items

Response

application/json

API product

API Product

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

The API product ID.

Example:b9e81174-b5bb-4638-a3c3-8afe61a0abf8

namestringrequired

The name of the API product

Example:My Name

descriptionstring | nullrequired

The description of the API product

Example:MyDescription

portal_idsarray[string](uuid)requiredunique-itemsDEPRECATED

The list of portal identifiers which this API product is published to.
This property is deprecated and will be removed in a future version. Use the portals property instead.

>= 0 items

portalsarray[object]required

The list of portals which this API product is published to

>= 0 items

* Additional properties are NOT allowed.
Show Child Parameters
version_countnumberrequired

The number of product versions attached to this API product

Example:10

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

labelsobjectrequired

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example:{"env":"test"}

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

patch/api-products/{id}

Body

{ "name": "API Product with Update Name", "description": "Updated text describing the API product" }
 
application/json

Delete API Product

Removes an individual API product.

delete

Path Parameters

idstring(uuid)required

API product identifier

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Response

API product was deleted successfully.

delete/api-products/{id}
 

API Product Documentation

Create API Product Document

Creates a document for an API product.

post

Path Parameters

apiProductIdstring(uuid)required

The API product identifier

Example:d32d905a-ed33-46a3-a093-d8f536af9a8a

Body

application/json

CreateDocumentPayload

a document payload

parent_document_idstring | null(uuid)

parent document id

Default:null

Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2

slugstringrequired

document slug. must be unique accross documents belonging to an api product

Match pattern:^[\w-]+$

<= 80 characters

Example:path-for-seo

statusstringrequired

Allowed values:publishedunpublished

titlestringrequired

document title

>= 1 characters

Example:How to create a document in Konnect DocumentHub

contentstring

Can be markdown string content or base64 encoded string

Example:## My Markdown

metadataobject

metadata of the document

Default:{}

Example:{"author":"John Doe"}

Response

application/json

API product document

ApiProductDocument

an api product document

idstring(uuid)required
parent_document_idstring | null(uuid)required
titlestringrequired
slugstringrequired
statusstringrequired

Allowed values:unpublishedpublished

metadataobjectrequired
contentstringrequired

The unencoded markdown string of the api product document.

astOne Of
array[object]required
HeadingBlockobject
Show Child Parameters
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

post/api-products/{apiProductId}/documents

Body

{ "slug": "api-product-document", "status": "published", "title": "API Product Document", "content": "IyBBUEkgUHJvZHVjdCBEb2N1bWVudCBIZWFkZXIKQVBJIHByb2R1Y3QgZG9jdW1lbnQgY29udGVudA==" }
 
application/json