Get an API Product Document

Returns a document for the API product.

get

Path Parameters

apiProductIdstring(uuid)required

The API product identifier

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

idstring(uuid)required

The document identifier related to the API product

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

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

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

Update an API Product Document

Updates a document for an API product.

patch

Path Parameters

apiProductIdstring(uuid)required

The API product identifier

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

idstring(uuid)required

The document identifier related to the API product

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

Body

application/json

UpdateDocumentAttributesAndContentPayload

a document payload

parent_document_idstring | null(uuid)

Parent document Id. If this value is explicitly set to null, the
document will be put as a top level document at the bottom of the tree.

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

slugstring

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

Match pattern:^[\w-]+$

<= 80 characters

Example:path-for-seo

statusstring

Allowed values:publishedunpublished

titlestring

document title

>= 1 characters

Example:How to update a document in Konnect DocumentHub

contentstring

Can be markdown string content or base64 encoded string

Example:YmFzZTY0LWVuY29kZWQgdGV4dCBzdHJpbmc=

metadataobject

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

patch/api-products/{apiProductId}/documents/{id}

Body

{ "parent_document_id": "dd4e1b98-3629-4dd3-acc0-759a726ffee2", "slug": "api-product-document", "status": "published", "title": "API Product Document", "metadata": { "author": "Jane Doe" } }
 
application/json

Delete API Product Documentation

Removes a document from an API product.

delete

Path Parameters

apiProductIdstring(uuid)required

The API product identifier

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

idstring(uuid)required

The document identifier related to the API product

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

Response

Document for the API product was deleted successfully.

delete/api-products/{apiProductId}/documents/{id}
 

API Product Versions

Create API Product Version

Creates a version of an API product.

post

Path Parameters

apiProductIdstring(uuid)required

The API Product ID

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

Body

application/json

Create API Product Version Request

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

Example: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 | null
* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

API product

API Product Version

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

The API product version identifier.

Example:9f5061ce-78f6-4452-9108-ad7c02821fd5

namestringrequired

The version of the API product

Example:FirstVersion

gateway_serviceobject | nullrequired
* Additional properties are NOT allowed.
Show Child Parameters
publish_statusstringrequiredDEPRECATED

This field is published if the API product version is published to at least one portal. This field is deprecated: Use PortalProductVersion.publish_status instead.

Allowed values:unpublishedpublished

Example:unpublished

deprecatedbooleanrequiredDEPRECATED

Whether this API product version is deprecated in at least one portal. This field is deprecated: Use PortalProductVersion.deprecated instead

Example:false

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

auth_strategy_sync_errorsarray | null[object]read-only

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

Example:{"plugin_name":"konnect-application-auth","value":"plugin_sync_error_comm","message":"Unable to connect to the control plane to update plugin"}

* Additional properties are NOT allowed.
Show Child Parameters
portalsarray[object]required

The list of portals which this API product version is configured for

>= 0 items

* Additional properties are NOT allowed.
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}/product-versions

Body

{ "name": "v1" }
 
application/json