USusekaneo
Projects

Archive project

Changed on

Hide a project from the default list without deleting it. Reversible with unarchive.

put/project/{id}/archive

Request

  • Base URL
    https://cloud.kaneo.app/api
  • URL
    https://cloud.kaneo.app/api/project/{id}/archive
  • Auth
    HTTP bearer

Path parameters

idstring required

Response

The archived project

idstring required
workspaceIdstring required
backgroundVersionstring nullable required
slugstring required

Short prefix used in task identifiers, e.g. KAN-12.

iconstring nullable required
namestring required
descriptionstring nullable required
createdAtstring date-time required
isPublicboolean nullable required

When true the project's board is readable without signing in, via /api/public-project/{id}.

archivedAtstring date-time nullable required

Non-null once archived; archived projects are hidden by default.

positionnumber required

Sidebar order, ascending.

lastTaskNumbernumber required

Highest task number issued in this project; the next task gets this plus one.

Changes

  • c9984766c765Revision changes
    • info

      added the non-success response with the status

    • info

      removed the non-success response with the status

  • c7b8a842601bRevision changes
    • breaking

      removed the media type text/plain for the response with the status

    • breaking

      removed the media type text/plain for the response with the status

    • breaking

      removed the media type text/plain for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status