Get an API product
Returns an API product.
Path Parameters
API product identifier
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
application/json
Response
API product
API Product
The API product ID.
Example:b9e81174-b5bb-4638-a3c3-8afe61a0abf8
The name of the API product
Example:My Name
The description of the API product
Example:MyDescription
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
The list of portals which this API product is published to
>= 0 items
Show Child Parameters
The number of product versions attached to this API product
Example:10
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
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 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"}
Authentication
Path Parameters
Update an individual API product
Updates an API product.
Path Parameters
API product identifier
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Body
application/json
Body
Update API Product Request
The request schema for updating an API product.
The name for the API product.
>= 1 characters<= 100 characters
Example:API Product
The description of the API product.
Example:Text describing the API product
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 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"}
The list of portal identifiers which this API product should be published to
>= 0 items
Response
application/json
Response
API product
API Product
The API product ID.
Example:b9e81174-b5bb-4638-a3c3-8afe61a0abf8
The name of the API product
Example:My Name
The description of the API product
Example:MyDescription
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
The list of portals which this API product is published to
>= 0 items
Show Child Parameters
The number of product versions attached to this API product
Example:10
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
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 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"}
Authentication
Path Parameters
Body
Delete API Product
Removes an individual API product.
Path Parameters
API product identifier
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Response
Response
API product was deleted successfully.
Authentication
Path Parameters
API Product Documentation
Create API Product Document
Creates a document for an API product.
Path Parameters
The API product identifier
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Body
application/json
Body
CreateDocumentPayload
a document payload
parent document id
Default:null
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
document slug. must be unique accross documents belonging to an api product
Match pattern:^[\w-]+$
<= 80 characters
Example:path-for-seo
Allowed values:publishedunpublished
document title
>= 1 characters
Example:How to create a document in Konnect DocumentHub
Can be markdown string content or base64 encoded string
Example:## My Markdown
metadata of the document
Default:{}
Example:{"author":"John Doe"}
Response
application/json
Response
API product document
ApiProductDocument
an api product document
Allowed values:unpublishedpublished
The unencoded markdown string of the api product document.
One OfShow Child Parameters
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