Post
/v2/Project/Import

Sample requests:

POST /Import - Import documention from external zip file url { "source_documentation_url": "https://yourdomain/documentation.zip", // Document360 standard file only accepted "publish_article": true, // import article and publish
"import_by": "5a619a315481302d50b736d8" // Document360 user id }

Security
API Key
Header parameter nameapi_token

Enter REST API key. To generate a key, go to Settings → Knowledge base portal → API tokens

Body parameters
Show example
object
source_documentation_url
string | null

Source documentation zip URL and the file format should be satisfied by Document360 standard. The maximum file size should be less than 1GB

publish_article
boolean

Import article and publish.

import_by
string | null

Document360 user-id

object
source_documentation_url
string | null

Source documentation zip URL and the file format should be satisfied by Document360 standard. The maximum file size should be less than 1GB

publish_article
boolean

Import article and publish.

import_by
string | null

Document360 user-id

object
source_documentation_url
string | null

Source documentation zip URL and the file format should be satisfied by Document360 standard. The maximum file size should be less than 1GB

publish_article
boolean

Import article and publish.

import_by
string | null

Document360 user-id

object
source_documentation_url
string | null

Source documentation zip URL and the file format should be satisfied by Document360 standard. The maximum file size should be less than 1GB

publish_article
boolean

Import article and publish.

import_by
string | null

Document360 user-id

Responses
200
400
Show example

Success

Collapse all
object
id
string | null

The ID of the import request. Use this ID to get the import details

status
string | null

Current status of the import

extension_data
object (ExtensionDataObject)
success
boolean

Status indication for customer API response

errors
Array of object (BaseError) | null

Errors in the customer API response

object
warnings
Array of object (BaseWarning) | null

Warnings in the customer API response

object
information
Array of object (BaseInformation) | null

Information passed by the customer API response

object