LabelsUpdate
objectLabels 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 “_”.
PublicLabelsUpdate
objectPublic 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 “_”.
PublishStatus
stringAllowed values:publishedunpublished
DocumentTree
objecta document tree
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
document slug
Example:path-for-seo
metadata of the document
Example:{"author":"John Doe"}
Allowed values:publishedunpublished
a document tree
Example:{"id":"d32d905a-ed33-46a3-a093-d8f536af9a8a","title":"Hello world","status":"published","slug":"hello-world","metadata":{"author":"John Doe"},"children":[]}
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
ChildNode
objectOne OfAllowed values:heading
Level of the heading which maps to HTML tag
>= 1<= 6
One OfList of children nodes of the current node