Skip to content

Document archiving and unarchiving a project - #432

Merged
jeremy merged 1 commit into
masterfrom
archive-project-api
Aug 5, 2026
Merged

Document archiving and unarchiving a project#432
jeremy merged 1 commit into
masterfrom
archive-project-api

Conversation

@jeremy

@jeremy jeremy commented Aug 5, 2026

Copy link
Copy Markdown
Member

You can archive and unarchive a project over the API. Both endpoints already existed, but they were undocumented and answered JSON requests with a redirect instead of a status code. They now return 204 No Content, and they're documented.

Archive a projectPUT /projects/1/status/archived.json

Unarchive a projectPUT /projects/1/status/active.json, which restores a project from the trash as well as from the archive.

This closes a gap in the docs: GET /projects.json?status=archived has always let you read archived projects, but there was no documented way to set that status.

Two responses worth knowing about, both documented:

  • On accounts where archiving and trashing projects is limited to admins and the project's creator, everyone else gets a 403 Forbidden when archiving. Unarchiving is not restricted this way.
  • Unarchiving returns 507 Insufficient Storage when the account has reached its project limit, with the same error body already documented under "Create a project".

If you're already calling these endpoints, they used to return a 302 to a URL that then failed. You'll now get a 204 directly. The archive or unarchive itself succeeded in both cases — the difference is that there's no longer a redirect to follow.


Synced from bc3 doc/api/ by script/api/sync_to_bc3_api — not a hand-edit.

Copilot AI balanced review requested due to automatic review settings August 5, 2026 16:11

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@jeremy
jeremy merged commit 7946c44 into master Aug 5, 2026
1 check failed
@jeremy
jeremy deleted the archive-project-api branch August 5, 2026 22:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants