Sync documentation and artifacts
POST/api/v1/assessments/:assessment_id/sync
Sync documentation and artifacts from runner into the API.
Copies data from the runner's Project document into the API's Note (documentation) and Artifact collections. The sync is idempotent running it multiple times updates existing records rather than creating duplicates. Owner / admin only, and only on completed assessments.
- Scope required:
assessments:update+ owner/admin role. - Rate-limit tier: read/default.
- Side-effects: may create/update Note and Artifact documents.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 409
- 422
- 429
- 500
Successful Response
Bad request — malformed input or failed validation.
Missing, expired, or invalid credentials.
Authenticated but not authorized for this resource. Note: cross-organization reads return 404, not 403.
Resource not found, or hidden for tenant-enumeration safety (the caller lacks permission to know whether the resource exists).
Conflict — the current resource state does not allow this operation (e.g. assessment already started, email already in use).
Semantic validation failure — request shape was valid but contents were not.
Too many requests — rate limited. Retry after the window resets.
Internal server error — unexpected failure.