Get an API Product Document
Returns a document for the API product.
Path Parameters
The API product identifier
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
The document identifier related to the API product
Example:de5c9818-be5c-42e6-b514-e3d4bc30ddeb
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
Authentication
Path Parameters
Update an API Product Document
Updates a document for an API product.
Path Parameters
The API product identifier
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
The document identifier related to the API product
Example:de5c9818-be5c-42e6-b514-e3d4bc30ddeb
Body
application/json
Body
UpdateDocumentAttributesAndContentPayload
a document payload
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
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 update a document in Konnect DocumentHub
Can be markdown string content or base64 encoded string
Example:YmFzZTY0LWVuY29kZWQgdGV4dCBzdHJpbmc=
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
Authentication
Path Parameters
Body
Delete API Product Documentation
Removes a document from an API product.
Path Parameters
The API product identifier
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
The document identifier related to the API product
Example:de5c9818-be5c-42e6-b514-e3d4bc30ddeb
Response
Response
Document for the API product was deleted successfully.
Authentication
Path Parameters
API Product Versions
Create API Product Version
Creates a version of an API product.
Path Parameters
The API Product ID
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Body
application/json
Body
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.
The version name of the API product version.
>= 1 characters
Example:v1
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
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
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"}
One OfShow Child Parameters
Response
application/json
Response
API product
API Product Version
The API product version identifier.
Example:9f5061ce-78f6-4452-9108-ad7c02821fd5
The version of the API product
Example:FirstVersion
Show Child Parameters
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
Whether this API product version is deprecated in at least one portal. This field is deprecated: Use PortalProductVersion.deprecated instead
Example:false
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"}
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"}
Show Child Parameters
The list of portals which this API product version is configured for
>= 0 items
Show 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