Projects

Updating Project Details

Changed on

The Project name may be updated, as well as the Project description and the archived flag.

By default, archived is not set, which is equivalent to false. If archived is set to true, the Project will be sorted to the bottom of the list, and in the web management application the Project will become effectively read-only. API write access will not be affected.

patch/v1/projects/{id}

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/projects/{id}
  • Auth
    none declared

Path parameters

idnumber required

The numeric ID of the Project

Request body */*

namestring required

The desired name of the Project.

descriptionstring

The description of the Project.

archivedboolean

Archives the Project.

Example request

{
  "name": "New Project Name",
  "description": "Description of this Project to show on Central.",
  "archived": true
}

Response

OK

idnumber

The numerical ID of the Project.

namestring required

The name of the Project.

descriptionstring

The description of the Project, which is rendered as Markdown on Frontend.

keyIdnumber

If managed encryption is enabled on the project, the numeric ID of the encryption key as tracked by Central is given here.

archivedboolean

Whether the Project is archived or not. null is equivalent to false. All this does is sort the Project to the bottom of the list and disable management features in the web management application.

Changes