Imports API
Import batches
GET /orgs/{org}/imports
Imports, newest first.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
org required | path | string | The org slug. |
Responses
200- OK. Paged_ImportJob
application/json
POST /orgs/{org}/imports
Starts an import batch.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
org required | path | string | The org slug. |
Request body
application/json, StartImport.
| Field | Type | Description |
|---|---|---|
dry_run | boolean | A rehearsal. |
source required | string | The source app. |
Responses
201- Created. ImportJob
application/json
GET /orgs/{org}/imports/{id}
An import's status and counts.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
org required | path | string | The org slug. |
id required | path | string (uuid) | The id. |
Responses
200- OK. ImportJob
application/json
POST /orgs/{org}/imports/{id}/finish
Marks an import done (no more batches).
Parameters
| Name | In | Type | Description |
|---|---|---|---|
org required | path | string | The org slug. |
id required | path | string (uuid) | The id. |
Responses
200- OK. ImportJob
application/json
POST /orgs/{org}/imports/{id}/undo
Undoes an import as a unit: every page it touched goes back to its revision before the import (pages it created go to the trash). 409 undo_conflict if any page changed since.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
org required | path | string | The org slug. |
id required | path | string (uuid) | The id. |
Responses
200- OK. ImportJob
application/json 409- Conflict. ProblemBody
application/json