Start Project Export — POST /api/v1/projects/{project_id}/export
Start Project Export
Queue an export of the project’s settings + catalog (an archived project too: the access rule is require_project_access’s, unchanged). 409 export_running names the live job. W30: no body / include_history: false == phase 1 exactly; include_history: true stores the options and dispatches with the history time limits (422 history_window_invalid / max_runs_invalid for a bad body).
Endpoint: POST /api/v1/projects/{project_id}/export
Authentication: Send a signed-in user’s access token in Authorization: Bearer <access token>, or an API key in X-API-Key: <API key>.
- A minimum role applies. The source code names it.
- You must be a member of the project. Admins always have access.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Default | Description |
|---|---|---|---|---|---|
project_id | path | yes | string (uuid) | ||
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 |
|---|---|---|
application/json | ProjectExportRequest or null | no |
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
202 | Successful Response | ProjectDataJobRead (application/json) |
422 | Validation Error | HTTPValidationError (application/json) |
Errors this endpoint returns, read from its source code:
404, with the message “Project not found”
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_export_api_v1_projects__project_id__export_post - Source code:
backend/app/routers/project_data.py, line 195 - Specification: OpenAPI JSON