Skip to main content

Paligo API

Parameters

Name

In

Type

Required

Description

body

body

ImportRequestPostPayload

false

none

» archive

body

string(binary)

false

The archive file to import.

» parent

body

integer

false

The ID of the target folder to import content into.

» type

body

string

false

The import type.

» match_components

body

boolean

false

When importing content the system can try to match content to already existing content. Check this option if you want Paligo to perform such a matching.

» generate_hazard

body

boolean

false

When selected, admonitions (notes, warnings, etc) will be imported as separate components. These are then reused in the parent component.

» ignore_warnings

body

boolean

false

When selected, warning messages about uploaded XML are ignored. Only use this if there are issues.

» zendesk_category

body

string

false

The Zendesk category if importing from Zendesk.

» openapi_languages

body

[string]

false

Snippet languages to generate when importing OpenAPI.

» openapi_maxdepth

body

integer

false

The maximum depth to show for schema examples when importing OpenAPI.

Enumerated Values

Parameter

Value

» type

paligo

» type

db5

» type

db4

» type

xhtml

» type

confluence

» type

dita

» type

flare

» type

helpandmanual

» type

docx

» type

authorit

» type

zendesk

» type

openapi