Skip to main content
POST
Create content tree node

Authorizations

Authorization
string
header
default:App
required

This is the most secure authorization type and the one with the most flexibility.

API keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can be revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases. Finally, the loss of an API key is easily manageable.

You can manage your API keys from GUI, or programmatically with dedicated API.

API key Authorization header example:

Body

application/json
type
enum<string>
required

Type of the tree node.

Available options:
CATEGORY,
FOLDER,
ARTICLE
Example:

"FOLDER"

name
string
required

Name of the tree node.

Minimum string length: 1
Example:

"Getting Started"

targetId
string<uuid>
required

Identifier of the target node for relative positioning.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

position
enum<string>
required

Position relative to the target node.

Available options:
ABOVE,
BELOW,
APPEND
Example:

"BELOW"

visibility
enum<string>

Visibility of the node.

Available options:
PRIVATE,
PUBLIC
Example:

"PUBLIC"

Response

Content tree node created successfully

name
string
required

Name of the tree node.

Example:

"Getting Started"

id
string<uuid>
required

Unique identifier of the tree node.

Example:

"3fa85f64-5717-4562-b3fc-2c963f66afa6"

parentId
string<uuid>
required

Identifier of the parent tree node.

Example:

"1fa85f64-5717-4562-b3fc-2c963f66afa6"

articleCount
integer<int32>
required

Number of articles in this node.

Example:

5

position
integer<int32>
required

Ordinal position of the node among siblings.

Example:

0

type
enum<string>
required

Type of the tree node.

Available options:
CATEGORY,
FOLDER,
ARTICLE
Example:

"FOLDER"

scope
enum<string>
required

Content scope of the node.

Available options:
INTERNAL,
EXTERNAL
Example:

"INTERNAL"

root
boolean
required

Whether this is a root node.

Example:

false

hasChildren
boolean

Whether this node has child nodes.

Example:

true

childList
array

Child nodes of this tree node.

source
enum<string>

External source of the node, if imported.

Available options:
CSV,
SHAREPOINT,
CONFLUENCE
Example:

"CONFLUENCE"

visibility
enum<string>

Visibility of the node.

Available options:
PRIVATE,
PUBLIC
Example:

"PUBLIC"