Sign in
Projects

Updating Project Details

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}

Path parameters

idnumber required

The numeric ID of the Project

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

Changed in 3 of the 54 revisions of this API.4

  • 022694254f0d1See the full diff
    • ○

      api operation id Updating Project Details removed and replaced with updateProjectDetails

      api-operation-id-removed

  • b11b54eea4871See the full diff
    • ○

      removed the non-success response with the status 403

      response-non-success-status-removed

  • e8c2858fd4eb2See the full diff
    • ○

      api operation id updateProjectDetails removed and replaced with Updating Project Details

      api-operation-id-removed

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog