DocumentHub developer Api
- Server 1:http://documenthub.documenthub.svc.cluster.local:4400/developer/v2
Konnect cluster
portalAccessToken (apiKey)
The Developer portal cookie is meant to be used by the Developer API to authenticate with.
DocumentHub developer Api
Konnect cluster
The Developer portal cookie is meant to be used by the Developer API to authenticate with.
document operations
List documents in a collection
The maximum number of items to include per page. The last page of a collection may include fewer items.
Example:10
Determines which page of the entities to retrieve.
Example:1
A field to filter on. Supported fields: slug, metadata.
Example:filter[name]=my-doc
Targeted collection
Example:bb84c46a-432d-4314-81e4-478614a52dcb
Documents in the collection
returns the pagination information
Get a document. Will be removed after
Unique slug of the document.
Example:/about/company
Targeted collection
Example:bb84c46a-432d-4314-81e4-478614a52dcb
Document
a document
the id of the document
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
the id of the parent document
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
the slug of the document
Example:getting-started
revision of a 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
Get the document
Targeted collection
Example:bb84c46a-432d-4314-81e4-478614a52dcb
Targeted document
Example:bb84c46a-432d-4314-81e4-478614a52dcb
Allowed values:text/markdownapplication/jsonapplication/vnd.konnect.document-nodes+json
Default:application/json
Document
a document
the id of the document
Example:d32d905a-ed33-46a3-a093-d8f536af9a8a
the id of the parent document
Example:dd4e1b98-3629-4dd3-acc0-759a726ffee2
the slug of the document
Example:getting-started
revision of a 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