Create API Product Request

object

The request schema to create an API product.

* Additional properties are NOT allowed.
namestringrequired

The name of the API product.

>= 1 characters<= 100 characters

Example:API Product

descriptionstring

The description of the API product.

Default:null

Example:Text describing the API product

labelsobject

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_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

Example:25a2624c-49fc-4764-99e1-224ed819f200

Example

Update API Product Request

object

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

The description of the API product.

Example:Text describing the API product

labelsobject

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

Example:25a2624c-49fc-4764-99e1-224ed819f200

Example

Create API Product Version Request

object

The request schema to create a version of an API product.
Note that the publish_status and deprecated fields are deprecated: Use PortalProductVersion.publish_status instead.

* Additional properties are NOT allowed.
namestringrequired

The version name of the API product version.

>= 1 characters

Example:v1

publish_statusstringDEPRECATED

The publish status of the API product version. Applies publish status to all related portal product versions. This field is deprecated: Use PortalProductVersion.publish_status instead.

Allowed values:unpublishedpublished

Default:unpublished

Example:unpublished

deprecatedbooleanDEPRECATED

Indicates if the version of the API product is deprecated. Applies deprecation or removes deprecation from all related portal product versions. This field is deprecated: Use PortalProductVersion.deprecated instead.

Default:false

labelsobject

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

gateway_serviceOne Of
GatewayServicePayloadobject
* Additional properties are NOT allowed.
Show Child Parameters
Example

Create API Product Version Specification Request

object

The request schema to create a specification for a version of an API product.

* Additional properties are NOT allowed.
namestringrequired

The name of the API product version specification

Match pattern:^.+(?:\.yaml|\.yml|\.json)$

>= 1 characters<= 255 characters

Example:oas.yaml

contentstring(byte)required

The base64 encoded contents of the API product version specification

>= 1 characters

Example:TXkgWUFNTCBvciBKU09OIGZvcm1hdHRlZCBPQVMgY29udGVudA==

Example

CreateDocumentPayload

object

a document payload

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

Example