NewProjectDescription

A stub object used to create a new TeamCity project. POST a NewProjectDescription object to the /app/rest/projects endpoint to do the following: * Create a blank project: specify name and optionally id and parentProject. Omit sourceProject. * Copy an existing project: specify name, parentProject, and sourceProject (the project whose settings and build configurations are copied).

Properties

copyAllAssociatedSettings

Returns true if all settings of a cloned configuration or template should be copied; otherwise, false.

projectsIdsMap

This is the internal property that is not intended to be used

buildTypesIdsMap

This is the internal property that is not intended to be used

vcsRootsIdsMap

This is the internal property that is not intended to be used

name

The name of the new project.

id

The desired external ID for the new project. If not specified, TeamCity generates one from the project name.

sourceProjectLocator

A locator string identifying the project to copy settings from. Deprecated: use 'sourceProject' instead.

sourceProject

The project whose settings are copied when creating this new project.

parentProject

The parent project under which the new project is created. If not specified, the project is created at the root level.

description

The optional description of the new project.

Schema

Below, you can find a full schema of this object, in XML and JSON formats. You can choose what fields to submit depending on your current needs. Different methods might expect different fields: the best approach is to request this entity via GET and use the response as a base for the following POST request.

A link to another object implies that you can substitute it with the schema of the linked object, if it is required for your call.

<newProjectDescription copyAllAssociatedSettings="true" description="This project builds and tests the backend service." id="MyNewProject" name="My New Project" sourceProjectLocator="id:ProjectToCopy">
  <projectsIdsMap count="3" href="/app/rest/buildTypes/id:MyBuild/parameters">
    <property>[[[property...|property.html]]]</property>
  </projectsIdsMap>
  <buildTypesIdsMap count="3" href="/app/rest/buildTypes/id:MyBuild/parameters">
    <property>[[[property...|property.html]]]</property>
  </buildTypesIdsMap>
  <vcsRootsIdsMap count="3" href="/app/rest/buildTypes/id:MyBuild/parameters">
    <property>[[[property...|property.html]]]</property>
  </vcsRootsIdsMap>
  <sourceProject archived="false" description="This subproject contains configurations that carry out delivery jobs" holdsPipeline="false" href="/app/rest/projects/id:BuildCacheNodeJS" id="BuildCacheNodeJS" internalId="project302" locator="id:MyProject" name="Build Cache — NodeJS" parentProjectId="S3BucketsTest" parentProjectInternalId="project82" parentProjectName="S3 Buckets Test" uuid="37dccab8-ddf9-4f81-a1ad-7815f0e841e1" virtual="false" webUrl="https://localhost:8111/project.html?projectId=BuildAndDeploy">
    <links>[[[links...|links.html]]]</links>
    <parentProject>[[[project...|project.html]]]</parentProject>
    <readOnlyUI>[[[StateField...|statefield.html]]]</readOnlyUI>
    <defaultTemplate>[[[buildType...|buildtype.html]]]</defaultTemplate>
    <buildTypes>[[[buildTypes...|buildtypes.html]]]</buildTypes>
    <templates>[[[buildTypes...|buildtypes.html]]]</templates>
    <deploymentDashboards>[[[deploymentDashboards...|deploymentdashboards.html]]]</deploymentDashboards>
    <parameters>[[[properties...|properties.html]]]</parameters>
    <vcsRoots>[[[vcs-roots...|vcsroots.html]]]</vcsRoots>
    <projectFeatures>[[[projectFeatures...|projectfeatures.html]]]</projectFeatures>
    <projects>[[[projects...|projects.html]]]</projects>
    <cloudProfiles>[[[cloudProfiles...|cloudprofiles.html]]]</cloudProfiles>
    <ancestorProjects>[[[projects...|projects.html]]]</ancestorProjects>
  </sourceProject>
  <parentProject archived="false" description="This subproject contains configurations that carry out delivery jobs" holdsPipeline="false" href="/app/rest/projects/id:BuildCacheNodeJS" id="BuildCacheNodeJS" internalId="project302" locator="id:MyProject" name="Build Cache — NodeJS" parentProjectId="S3BucketsTest" parentProjectInternalId="project82" parentProjectName="S3 Buckets Test" uuid="37dccab8-ddf9-4f81-a1ad-7815f0e841e1" virtual="false" webUrl="https://localhost:8111/project.html?projectId=BuildAndDeploy">
    <links>[[[links...|links.html]]]</links>
    <parentProject>[[[project...|project.html]]]</parentProject>
    <readOnlyUI>[[[StateField...|statefield.html]]]</readOnlyUI>
    <defaultTemplate>[[[buildType...|buildtype.html]]]</defaultTemplate>
    <buildTypes>[[[buildTypes...|buildtypes.html]]]</buildTypes>
    <templates>[[[buildTypes...|buildtypes.html]]]</templates>
    <deploymentDashboards>[[[deploymentDashboards...|deploymentdashboards.html]]]</deploymentDashboards>
    <parameters>[[[properties...|properties.html]]]</parameters>
    <vcsRoots>[[[vcs-roots...|vcsroots.html]]]</vcsRoots>
    <projectFeatures>[[[projectFeatures...|projectfeatures.html]]]</projectFeatures>
    <projects>[[[projects...|projects.html]]]</projects>
    <cloudProfiles>[[[cloudProfiles...|cloudprofiles.html]]]</cloudProfiles>
    <ancestorProjects>[[[projects...|projects.html]]]</ancestorProjects>
  </parentProject>
</newProjectDescription>

{
  "buildTypesIdsMap" : {
    "count" : 3,
    "property" : [ {
      "inherited" : false,
      "name" : "my.build.param",
      "type" : "[[[type...|type.html]]]",
      "value" : "production"
    } ],
    "href" : "/app/rest/buildTypes/id:MyBuild/parameters"
  },
  "parentProject" : {
    "holdsPipeline" : false,
    "virtual" : false,
    "parentProjectName" : "S3 Buckets Test",
    "vcsRoots" : {
      "count" : 10,
      "vcs-root" : [ "[[[vcs-root...|vcsroot.html]]]" ],
      "prevHref" : "/app/rest/vcs-roots?locator=count:10,start:90",
      "href" : "/app/rest/vcs-roots?locator=count:10,start:100",
      "nextHref" : "/app/rest/vcs-roots?locator=count:10,start:110"
    },
    "projects" : {
      "count" : 39,
      "project" : [ "[[[project...|project.html]]]" ],
      "prevHref" : "/app/rest/projects?locator=count:10,start:0",
      "href" : "/app/rest/projects?locator=count:30,start:10",
      "nextHref" : "/app/rest/projects?locator=count:30,start:40"
    },
    "defaultTemplate" : {
      "template" : "[[[buildType...|buildtype.html]]]",
      "paused" : false,
      "output-parameters" : "[[[properties...|properties.html]]]",
      "description" : "Deploys artifacts to the public registry",
      "project" : "[[[project...|project.html]]]",
      "investigations" : "[[[investigations...|investigations.html]]]",
      "templateFlag" : false,
      "type" : "regular",
      "uuid" : "8e7eafb8-321b-456e-84db-e73714c8fa3f",
      "projectInternalId" : "project762",
      "internalId" : "bt1057",
      "features" : "[[[features...|features.html]]]",
      "builds" : "[[[builds...|builds.html]]]",
      "links" : "[[[links...|links.html]]]",
      "id" : "Deployments_DeployToGlobal",
      "href" : "/app/rest/buildTypes/id:Deployments_DeployToGlobal",
      "compatibleCloudImages" : "[[[cloudImages...|cloudimages.html]]]",
      "settings" : "[[[properties...|properties.html]]]",
      "vcsRootInstances" : "[[[vcs-root-instances...|vcsrootinstances.html]]]",
      "templates" : "[[[buildTypes...|buildtypes.html]]]",
      "artifact-dependencies" : "[[[artifact-dependencies...|artifactdependencies.html]]]",
      "compatibleAgents" : "[[[agents...|agents.html]]]",
      "pauseComment" : "[[[comment...|comment.html]]]",
      "triggers" : "[[[triggers...|triggers.html]]]",
      "branches" : "[[[branches...|branches.html]]]",
      "steps" : "[[[steps...|steps.html]]]",
      "externalStatusAllowed" : false,
      "agent-requirements" : "[[[agent-requirements...|agentrequirements.html]]]",
      "webUrl" : "https://localhost:8111/buildConfiguration/Deployments_DeployToGlobal?mode=builds",
      "inherited" : false,
      "snapshot-dependencies" : "[[[snapshot-dependencies...|snapshotdependencies.html]]]",
      "name" : "Deploy To Global",
      "vcs-root-entries" : "[[[vcs-root-entries...|vcsrootentries.html]]]",
      "projectName" : "Deployments",
      "projectId" : "Deployments",
      "parameters" : "[[[properties...|properties.html]]]",
      "locator" : "id:Deployments_DeployToGlobal"
    },
    "description" : "This subproject contains configurations that carry out delivery jobs",
    "uuid" : "37dccab8-ddf9-4f81-a1ad-7815f0e841e1",
    "parentProjectInternalId" : "project82",
    "cloudProfiles" : {
      "count" : 4,
      "prevHref" : "/app/rest/cloud/profiles?locator=count:50,start:0",
      "href" : "/app/rest/cloud/profiles",
      "cloudProfile" : [ "[[[cloudProfile...|cloudprofile.html]]]" ],
      "nextHref" : "/app/rest/cloud/profiles?locator=count:200,start:250"
    },
    "internalId" : "project302",
    "archived" : false,
    "parentProjectId" : "S3BucketsTest",
    "deploymentDashboards" : {
      "count" : 3,
      "deploymentDashboard" : [ "[[[deploymentDashboard...|deploymentdashboard.html]]]" ],
      "prevHref" : "/app/rest/deploymentDashboards?locator=count:100,start:0",
      "href" : "/app/rest/deploymentDashboards",
      "nextHref" : "/app/rest/deploymentDashboards?locator=count:100,start:100"
    },
    "links" : {
      "link" : [ "[[[link...|link.html]]]" ],
      "count" : 1
    },
    "id" : "BuildCacheNodeJS",
    "href" : "/app/rest/projects/id:BuildCacheNodeJS",
    "parentProject" : {
      "holdsPipeline" : false,
      "virtual" : false,
      "parentProjectName" : "S3 Buckets Test",
      "vcsRoots" : "[[[vcs-roots...|vcsroots.html]]]",
      "projects" : "[[[projects...|projects.html]]]",
      "defaultTemplate" : "[[[buildType...|buildtype.html]]]",
      "description" : "This subproject contains configurations that carry out delivery jobs",
      "uuid" : "37dccab8-ddf9-4f81-a1ad-7815f0e841e1",
      "parentProjectInternalId" : "project82",
      "cloudProfiles" : "[[[cloudProfiles...|cloudprofiles.html]]]",
      "internalId" : "project302",
      "archived" : false,
      "parentProjectId" : "S3BucketsTest",
      "deploymentDashboards" : "[[[deploymentDashboards...|deploymentdashboards.html]]]",
      "links" : "[[[links...|links.html]]]",
      "id" : "BuildCacheNodeJS",
      "href" : "/app/rest/projects/id:BuildCacheNodeJS",
      "parentProject" : "[[[project...|project.html]]]",
      "templates" : "[[[buildTypes...|buildtypes.html]]]",
      "readOnlyUI" : "[[[StateField...|statefield.html]]]",
      "webUrl" : "https://localhost:8111/project.html?projectId=BuildAndDeploy",
      "buildTypes" : "[[[buildTypes...|buildtypes.html]]]",
      "name" : "Build Cache — NodeJS",
      "ancestorProjects" : "[[[projects...|projects.html]]]",
      "parameters" : "[[[properties...|properties.html]]]",
      "projectFeatures" : "[[[projectFeatures...|projectfeatures.html]]]",
      "locator" : "id:MyProject"
    },
    "templates" : {
      "buildType" : [ "[[[buildType...|buildtype.html]]]" ],
      "count" : 30,
      "prevHref" : "/app/rest/vcs-roots?locator=count:20,start:0",
      "href" : "/app/rest/vcs-roots?locator=count:30,start:20",
      "nextHref" : "/app/rest/vcs-roots?locator=count:30,start:50"
    },
    "readOnlyUI" : {
      "inherited" : false,
      "value" : false
    },
    "webUrl" : "https://localhost:8111/project.html?projectId=BuildAndDeploy",
    "buildTypes" : {
      "buildType" : [ "[[[buildType...|buildtype.html]]]" ],
      "count" : 30,
      "prevHref" : "/app/rest/vcs-roots?locator=count:20,start:0",
      "href" : "/app/rest/vcs-roots?locator=count:30,start:20",
      "nextHref" : "/app/rest/vcs-roots?locator=count:30,start:50"
    },
    "name" : "Build Cache — NodeJS",
    "ancestorProjects" : {
      "count" : 39,
      "project" : [ "[[[project...|project.html]]]" ],
      "prevHref" : "/app/rest/projects?locator=count:10,start:0",
      "href" : "/app/rest/projects?locator=count:30,start:10",
      "nextHref" : "/app/rest/projects?locator=count:30,start:40"
    },
    "parameters" : {
      "count" : 3,
      "property" : [ {
        "inherited" : false,
        "name" : "my.build.param",
        "type" : "[[[type...|type.html]]]",
        "value" : "production"
      } ],
      "href" : "/app/rest/buildTypes/id:MyBuild/parameters"
    },
    "projectFeatures" : {
      "projectFeature" : [ "[[[projectFeature...|projectfeature.html]]]" ],
      "count" : 3,
      "href" : "/app/rest/projects/id:MyProject/projectFeatures"
    },
    "locator" : "id:MyProject"
  },
  "sourceProjectLocator" : "id:ProjectToCopy",
  "name" : "My New Project",
  "projectsIdsMap" : {
    "count" : 3,
    "property" : [ {
      "inherited" : false,
      "name" : "my.build.param",
      "type" : "[[[type...|type.html]]]",
      "value" : "production"
    } ],
    "href" : "/app/rest/buildTypes/id:MyBuild/parameters"
  },
  "vcsRootsIdsMap" : {
    "count" : 3,
    "property" : [ {
      "inherited" : false,
      "name" : "my.build.param",
      "type" : "[[[type...|type.html]]]",
      "value" : "production"
    } ],
    "href" : "/app/rest/buildTypes/id:MyBuild/parameters"
  },
  "description" : "This project builds and tests the backend service.",
  "id" : "MyNewProject",
  "copyAllAssociatedSettings" : true,
  "sourceProject" : {
    "holdsPipeline" : false,
    "virtual" : false,
    "parentProjectName" : "S3 Buckets Test",
    "vcsRoots" : {
      "count" : 10,
      "vcs-root" : [ "[[[vcs-root...|vcsroot.html]]]" ],
      "prevHref" : "/app/rest/vcs-roots?locator=count:10,start:90",
      "href" : "/app/rest/vcs-roots?locator=count:10,start:100",
      "nextHref" : "/app/rest/vcs-roots?locator=count:10,start:110"
    },
    "projects" : {
      "count" : 39,
      "project" : [ "[[[project...|project.html]]]" ],
      "prevHref" : "/app/rest/projects?locator=count:10,start:0",
      "href" : "/app/rest/projects?locator=count:30,start:10",
      "nextHref" : "/app/rest/projects?locator=count:30,start:40"
    },
    "defaultTemplate" : {
      "template" : "[[[buildType...|buildtype.html]]]",
      "paused" : false,
      "output-parameters" : "[[[properties...|properties.html]]]",
      "description" : "Deploys artifacts to the public registry",
      "project" : "[[[project...|project.html]]]",
      "investigations" : "[[[investigations...|investigations.html]]]",
      "templateFlag" : false,
      "type" : "regular",
      "uuid" : "8e7eafb8-321b-456e-84db-e73714c8fa3f",
      "projectInternalId" : "project762",
      "internalId" : "bt1057",
      "features" : "[[[features...|features.html]]]",
      "builds" : "[[[builds...|builds.html]]]",
      "links" : "[[[links...|links.html]]]",
      "id" : "Deployments_DeployToGlobal",
      "href" : "/app/rest/buildTypes/id:Deployments_DeployToGlobal",
      "compatibleCloudImages" : "[[[cloudImages...|cloudimages.html]]]",
      "settings" : "[[[properties...|properties.html]]]",
      "vcsRootInstances" : "[[[vcs-root-instances...|vcsrootinstances.html]]]",
      "templates" : "[[[buildTypes...|buildtypes.html]]]",
      "artifact-dependencies" : "[[[artifact-dependencies...|artifactdependencies.html]]]",
      "compatibleAgents" : "[[[agents...|agents.html]]]",
      "pauseComment" : "[[[comment...|comment.html]]]",
      "triggers" : "[[[triggers...|triggers.html]]]",
      "branches" : "[[[branches...|branches.html]]]",
      "steps" : "[[[steps...|steps.html]]]",
      "externalStatusAllowed" : false,
      "agent-requirements" : "[[[agent-requirements...|agentrequirements.html]]]",
      "webUrl" : "https://localhost:8111/buildConfiguration/Deployments_DeployToGlobal?mode=builds",
      "inherited" : false,
      "snapshot-dependencies" : "[[[snapshot-dependencies...|snapshotdependencies.html]]]",
      "name" : "Deploy To Global",
      "vcs-root-entries" : "[[[vcs-root-entries...|vcsrootentries.html]]]",
      "projectName" : "Deployments",
      "projectId" : "Deployments",
      "parameters" : "[[[properties...|properties.html]]]",
      "locator" : "id:Deployments_DeployToGlobal"
    },
    "description" : "This subproject contains configurations that carry out delivery jobs",
    "uuid" : "37dccab8-ddf9-4f81-a1ad-7815f0e841e1",
    "parentProjectInternalId" : "project82",
    "cloudProfiles" : {
      "count" : 4,
      "prevHref" : "/app/rest/cloud/profiles?locator=count:50,start:0",
      "href" : "/app/rest/cloud/profiles",
      "cloudProfile" : [ "[[[cloudProfile...|cloudprofile.html]]]" ],
      "nextHref" : "/app/rest/cloud/profiles?locator=count:200,start:250"
    },
    "internalId" : "project302",
    "archived" : false,
    "parentProjectId" : "S3BucketsTest",
    "deploymentDashboards" : {
      "count" : 3,
      "deploymentDashboard" : [ "[[[deploymentDashboard...|deploymentdashboard.html]]]" ],
      "prevHref" : "/app/rest/deploymentDashboards?locator=count:100,start:0",
      "href" : "/app/rest/deploymentDashboards",
      "nextHref" : "/app/rest/deploymentDashboards?locator=count:100,start:100"
    },
    "links" : {
      "link" : [ "[[[link...|link.html]]]" ],
      "count" : 1
    },
    "id" : "BuildCacheNodeJS",
    "href" : "/app/rest/projects/id:BuildCacheNodeJS",
    "parentProject" : {
      "holdsPipeline" : false,
      "virtual" : false,
      "parentProjectName" : "S3 Buckets Test",
      "vcsRoots" : "[[[vcs-roots...|vcsroots.html]]]",
      "projects" : "[[[projects...|projects.html]]]",
      "defaultTemplate" : "[[[buildType...|buildtype.html]]]",
      "description" : "This subproject contains configurations that carry out delivery jobs",
      "uuid" : "37dccab8-ddf9-4f81-a1ad-7815f0e841e1",
      "parentProjectInternalId" : "project82",
      "cloudProfiles" : "[[[cloudProfiles...|cloudprofiles.html]]]",
      "internalId" : "project302",
      "archived" : false,
      "parentProjectId" : "S3BucketsTest",
      "deploymentDashboards" : "[[[deploymentDashboards...|deploymentdashboards.html]]]",
      "links" : "[[[links...|links.html]]]",
      "id" : "BuildCacheNodeJS",
      "href" : "/app/rest/projects/id:BuildCacheNodeJS",
      "parentProject" : "[[[project...|project.html]]]",
      "templates" : "[[[buildTypes...|buildtypes.html]]]",
      "readOnlyUI" : "[[[StateField...|statefield.html]]]",
      "webUrl" : "https://localhost:8111/project.html?projectId=BuildAndDeploy",
      "buildTypes" : "[[[buildTypes...|buildtypes.html]]]",
      "name" : "Build Cache — NodeJS",
      "ancestorProjects" : "[[[projects...|projects.html]]]",
      "parameters" : "[[[properties...|properties.html]]]",
      "projectFeatures" : "[[[projectFeatures...|projectfeatures.html]]]",
      "locator" : "id:MyProject"
    },
    "templates" : {
      "buildType" : [ "[[[buildType...|buildtype.html]]]" ],
      "count" : 30,
      "prevHref" : "/app/rest/vcs-roots?locator=count:20,start:0",
      "href" : "/app/rest/vcs-roots?locator=count:30,start:20",
      "nextHref" : "/app/rest/vcs-roots?locator=count:30,start:50"
    },
    "readOnlyUI" : {
      "inherited" : false,
      "value" : false
    },
    "webUrl" : "https://localhost:8111/project.html?projectId=BuildAndDeploy",
    "buildTypes" : {
      "buildType" : [ "[[[buildType...|buildtype.html]]]" ],
      "count" : 30,
      "prevHref" : "/app/rest/vcs-roots?locator=count:20,start:0",
      "href" : "/app/rest/vcs-roots?locator=count:30,start:20",
      "nextHref" : "/app/rest/vcs-roots?locator=count:30,start:50"
    },
    "name" : "Build Cache — NodeJS",
    "ancestorProjects" : {
      "count" : 39,
      "project" : [ "[[[project...|project.html]]]" ],
      "prevHref" : "/app/rest/projects?locator=count:10,start:0",
      "href" : "/app/rest/projects?locator=count:30,start:10",
      "nextHref" : "/app/rest/projects?locator=count:30,start:40"
    },
    "parameters" : {
      "count" : 3,
      "property" : [ {
        "inherited" : false,
        "name" : "my.build.param",
        "type" : "[[[type...|type.html]]]",
        "value" : "production"
      } ],
      "href" : "/app/rest/buildTypes/id:MyBuild/parameters"
    },
    "projectFeatures" : {
      "projectFeature" : [ "[[[projectFeature...|projectfeature.html]]]" ],
      "count" : 3,
      "href" : "/app/rest/projects/id:MyProject/projectFeatures"
    },
    "locator" : "id:MyProject"
  }
}

Last modified: 18 August 2026