Archive an assessment
POST/api/v1/assessments/:assessment_id/archive
Archive an assessment. Display-only and idempotent.
Archiving drops the assessment (and its findings) out of the primary
surfaces — Dashboard recents, default Assessments / Findings /
Reports lists — while it stays retrievable via the archived=true
filter. It is NOT an admission gate: in-flight runs continue and the
lifecycle status is untouched. Mirrors the Project archive UX.
Write access required (owner/admin any; manager own-created only). A running / pending assessment cannot be archived (409) — archive it after the run finishes.
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.