Export documentation
- 02 Feb 2022
- 1 Minute to read
-
Contributors
-
Print
-
DarkLight
Export documentation
- Updated on 02 Feb 2022
- 1 Minute to read
-
Contributors
-
Print
-
DarkLight
POST /project/export
Start a new export
Header
| Parameter | Type | Description |
|---|---|---|
| api_token | string | You can get the REST API from Settings > Advanced > API tokens. |
Body Parameters
| Parameter | Required | Type | Description |
|---|---|---|---|
| entity | Yes | string | Area to export. It can be Project or Version or Category or Article |
| entity_ids | Conditionally | string[] | IDs of the entities. For example, if the entity is Category then the fields have to be category IDs. This is required for entities other than Project. |
| filter_by_article_modified_at | No | object | Filter articles by modified date-time |
| exclude_media_files | No | bool | If true, media files will not be included in the .zip file |
Body Parameters > filter_by_article_modified_at
| Parameter | Type | Description |
|---|---|---|
| after | string | Filter the articles which are all modified after the given date |
| before | string | Filter the articles which are all modified before the given date |
Sample Request
To export the documentation at the Project level
{
"entity": "Project", // Version/Category/Article
"entity_ids": [], // should be empty array
"filter_by_article_modified_at": { // filter articles by modified at date range
"after": "2021-05-17T03:42:52.109Z",
"before": "2021-05-17T03:42:52.109Z"
},
"exclude_media_files": true
}
To export the documentation at Version/Category/Article level
{
"entity": "Version",
"entity_ids": ["695782c0-a0a3-4664-9bfd-0197d26379ee"], // Pass ',' separated values for multiple versions
"filter_by_article_modified_at": null,
"exclude_media_files": true
}
Sample Response
{
"id": "4039df02-ccca-4461-b4a1-eec107a19de3",
"status": "Initiated",
"success": true,
"errors": [],
"warnings": [],
"information": []
}
Response Data
| Parameter | Type | Description |
|---|---|---|
| id | string | The ID of the export request. Use this ID to get export details |
| status | string | Current status of the export |
Was this article helpful?