API Product

object
* 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

descriptionstringrequired

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

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

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

Example

API Product Document Summary

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

The API product document identifier.

Example:de5c9818-be5c-42e6-b514-e3d4bc30ddeb

parent_document_idstring(uuid)required

The parent API product document identifier.

slugstringrequired

API product document slug

Match pattern:^[\w-]+$

Example:api-product-document

statusstringrequired

Allowed values:publishedunpublished

titlestringrequired

API product document title

Example:API Product Document

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

Example

ApiProductDocument

object

an api product document

idstring(uuid)required
parent_document_idstring(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

Example

AuthStrategySyncError

object
* Additional properties are NOT allowed.
plugin_namestring
valuestring

Allowed values:plugin_sync_error_commplugin_sync_error_unknownplugin_sync_error_fatalplugin_sync_error_updating_plugin_refs

messagestringrequired
infoobject
* Additional properties are allowed.
Show Child Parameters
Example

AuthStrategySyncErrors

array

The set of errors encountered when trying to sync the auth strategies on the version

plugin_namestring
valuestring

Allowed values:plugin_sync_error_commplugin_sync_error_unknownplugin_sync_error_fatalplugin_sync_error_updating_plugin_refs

messagestringrequired
infoobject
* Additional properties are allowed.
Show Child Parameters
Example