TeamCity REST API Reference
 
2023.05
You are viewing the documentation for an earlier version of TeamCity REST API Reference.
  1. Common Use Cases
  2. Manage Projects
  3. Create and Delete Projects

Create and Delete Projects

Last modified: 27 December 2022

This article shows how to create, archive, and remove projects via TeamCity REST API.

Create Project

To create a project, compose and post a NewProjectDescription entity to:

POST
/app/rest/projects

Specify name, id, and parentProject via its locator string (to define a project under the Root project, use id:_Root).

Example payload:

<newProjectDescription copyAllAssociatedSettings="true" id="string" name="string">
  <parentProject locator="string" />
</newProjectDescription>

Copy Project

To make a copy of an existing project, add the sourceProject locator to define the source project.

Example payload:

<newProjectDescription copyAllAssociatedSettings="true" id="string" name="string">
  <sourceProject locator="string" />
  <parentProject locator="string" />
</newProjectDescription>

Archive Project

To get a project's archived status, use:

GET
/app/rest/projects/<projectLocator>/archived

To update its status, use:

PUT
/app/rest/projects/<projectLocator>/archived

The payload should be either true or false.

Delete Project

To delete a project, use:

DELETE
/app/rest/projects/<projectLocator>

The projectLocator parameter is a locator string typed as ProjectLocator. For example, to delete a project with the ID MyCustomProject, use:

DELETE
/app/rest/projects/id:MyCustomProject