Start Project Import — POST /api/v1/projects/import
Start Project Import
Accept an export ZIP to import as a NEW project. The body is counted into a spool before any job row exists (413 past 50 MB, nothing stored); a repeated client_token answers 200 with its job and reads nothing. Commit, then enqueue; 202.
Endpoint: POST /api/v1/projects/import
Authentication: Send a signed-in user’s access token in Authorization: Bearer <access token>, or an API key in X-API-Key: <API key>.
- Your role must be Admin or higher.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Default | Description |
|---|---|---|---|---|---|
X-API-Key | header | no | string or null | API key, as an alternative to the access token (see Authentication). |
Request body
Section titled “Request body”| Content type | Body | Required |
|---|---|---|
multipart/form-data | Body_start_project_import_api_v1_projects_import_post | no |
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
202 | Successful Response | ProjectDataJobRead (application/json) |
422 | Validation Error | HTTPValidationError (application/json) |
It can also return 401 if your credential is missing or expired, 403 if your credential does not allow this request, and 404 if the item does not exist or you cannot see it. Your role, your project membership and the key’s scope decide what a credential allows. See Errors and retries.
More details
Section titled “More details”- Group: Project data
- Operation ID:
start_project_import_api_v1_projects_import_post - Source code:
backend/app/routers/project_data.py, line 366 - Specification: OpenAPI JSON