Archive or restore a project

Archives or restores the caller's project. Archiving parks the complete project: no new occurrence is dispatched, while schedules, endpoints, keys, grants and retained history remain intact. Restoring clears that project-wide hold without rewriting any schedule; an occurrence whose instant passed while archived becomes due, matching schedule pause and resume. Only organization administrators may make this project-wide change.

post/v1/projects/{projectId}/archive

Request

  • Base URL: https://docs.greatwait.dev (the document declares no server; this is the origin it was published from)
  • URL: https://docs.greatwait.dev/v1/projects/{projectId}/archive
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer and API key in header Greatwait-Environment and API key in header Greatwait-Project

Path parameters

projectIdstring required

Headers

If-Matchstring required

Request body

archivedboolean required

Response

Archive or restore a project

createdAtstring nullable required
environmentKindsstring[] required
idstring required
namestring required
status'active' | 'archived' required
versioninteger required

Changes

No recorded changes to this operation across all 1 revision of this API.