API Product Document Summary
objectThe API product document identifier.
Example:de5c9818-be5c-42e6-b514-e3d4bc30ddeb
The parent API product document identifier.
API product document slug
Match pattern:^[\w-]+$
Example:api-product-document
Allowed values:publishedunpublished
API product document title
Example:API Product Document
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
ApiProductDocument
objectan 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
AuthStrategySyncError
objectAllowed values:plugin_sync_error_commplugin_sync_error_unknownplugin_sync_error_fatalplugin_sync_error_updating_plugin_refs
Show Child Parameters
AuthStrategySyncErrors
arrayThe set of errors encountered when trying to sync the auth strategies on the version
Allowed values:plugin_sync_error_commplugin_sync_error_unknownplugin_sync_error_fatalplugin_sync_error_updating_plugin_refs
Show Child Parameters
API Product Version
objectThe 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
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