Projects

Creating a Project

Changed on

To create a Project, the only information you must supply (via POST body) is the desired name of the Project.

post/v1/projects

Request

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

Request body */*

namestring required

The desired name of the Project.

Example request

{
  "name": "Project Name"
}

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