Import documentation
  • 03 Jun 2021
  • 1 Minute to read
  • Contributors
  • Dark
    Light

Import documentation

  • Dark
    Light

POST/project/import

Import documentation from source documentation URL


Parameter Type Description
api_token string REST API key you can get it from Settings > API.

Body Parameters

Parameters highlighted in bold are mandatory

Parameter Type Description
source_documentation_url string Source documentation zip URL and the file format should be satisfied by Document360 standard. The max file size should be less than 1GB
publish_article boolean Import article and publish.
import_by string Document360 user id

Sample Request

{
  "source_documentation_url": "https://yourdomain/documentation.zip",
  "publish_article": true,
  "import_by": "5ac49a020d465134b9f490a3"
}

Sample Response

{
  "id": "44eccfcf-7b9d-4230-97a0-69741d77b98d",
  "status": "Queued",
  "success": true,
  "errors": [],
  "warnings": [],
  "information": []
}

Response Data

Parameter Type Description
id string ID of the import request. Use this ID to get the import details
status string Current status of the import

Was this article helpful?