Project

A TeamCity project that owns other projects and/or individual build configurations (build types).

Related Help article: Steps, Configurations and Projects

Properties

id

The public project ID. If not specified, TeamCity generates one by removing all non-alphanumeric characters from the project name.

internalId

The internally used read-only project ID.

uuid

The universally unique identifier of this project.

name

The public project name.

parentProjectId

The ID of a TeamCity project that owns this project. Returns '_Root' if this is project resides on the topmost level.

parentProjectInternalId

The internal ID of a TeamCity project that owns this project. This property is deprecated, use parent and parentProjectId to identify parent projects and retrieve their properties.

parentProjectName

The public name of a TeamCity project that owns this project. This property is deprecated, use parent and parentProjectId to identify parent projects and retrieve their properties.

archived

Returns true if the project is archived; otherwise, false.

virtual

Returns true if this project is dynamically created by TeamCity; false if this a regular project created by a user.

description

The optional project description, or null if none was set.

href

The shortest REST API link to this project (without the TeamCity server URL).

webUrl

The regular URL of the project.

links

The object that stores links to this project in both edit and view modes.

parentProject

The TeamCity project that owns this project.

readOnlyUI

Returns a StateField object that specifies whether the project along with its child build configurations cannot be edited in TeamCity UI. Project settings are locked if this project stores its settings in a VCS with enabled synchronization, and the 'Allow editing project settings via UI' option is toggled off.

defaultTemplate

Returns a template that serves as a default settings template for this project. Settings stored in a default template are automatically applied to all new configurations owned by this project.

buildTypes

The list of build configurations (build types) owned directly by this project. Does not inlcude configurations owned by subprojects.

templates

Returns the list of templates owned by this project.

deploymentDashboards

parameters

The collection of all configuration parameters and environment variables owned by this project. Includes parameters inherited from a parent project.

vcsRoots

The list of VCS roots owned by this project.

projectFeatures

The list of connections, artifact storages, cloud profiles, and other project-level entities owned by this project.

projects

The list of child sub-projects of this TeamCity project.

cloudProfiles

Agent cloud profiles owned by this project. Does not include cloud profiles owned by parent or child projects.

ancestorProjects

Returns the list of parent TeamCity projects, starting with the _Root project (first element of the Projects collection).

locator

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.

<project archived="false" description="This subproject contains configurations that carry out delivery jobs" href="/app/rest/projects/id:BuildCacheNodeJS" id="BuildCacheNodeJS" internalId="project302" locator="string" 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 count="123">
    <link>[[[link...|link.html]]]</link>
  </links>
  <parentProject archived="false" description="This subproject contains configurations that carry out delivery jobs" href="/app/rest/projects/id:BuildCacheNodeJS" id="BuildCacheNodeJS" internalId="project302" locator="string" 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...|]]]</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>
  <readOnlyUI inherited="true" value="true"/>
  <defaultTemplate description="Deploys artifacts to the public registry" externalStatusAllowed="false" href="/app/rest/buildTypes/id:Deployments_DeployToGlobal" id="Deployments_DeployToGlobal" inherited="false" internalId="bt1057" locator="string" name="Deploy To Global" paused="false" projectId="Deployments" projectInternalId="project762" projectName="Deployments" templateFlag="false" type="regular" uuid="8e7eafb8-321b-456e-84db-e73714c8fa3f" webUrl="https://localhost:8111/buildConfiguration/Deployments_DeployToGlobal?mode=builds">
    <links>[[[links...|links.html]]]</links>
    <project>[[[project...|]]]</project>
    <templates>[[[buildTypes...|buildtypes.html]]]</templates>
    <template>[[[buildType...|buildtype.html]]]</template>
    <vcs-root-entries>[[[vcs-root-entries...|vcsrootentries.html]]]</vcs-root-entries>
    <settings>[[[properties...|properties.html]]]</settings>
    <parameters>[[[properties...|properties.html]]]</parameters>
    <output-parameters>[[[properties...|properties.html]]]</output-parameters>
    <steps>[[[steps...|steps.html]]]</steps>
    <features>[[[features...|features.html]]]</features>
    <triggers>[[[triggers...|triggers.html]]]</triggers>
    <snapshot-dependencies>[[[snapshot-dependencies...|snapshotdependencies.html]]]</snapshot-dependencies>
    <artifact-dependencies>[[[artifact-dependencies...|artifactdependencies.html]]]</artifact-dependencies>
    <agent-requirements>[[[agent-requirements...|agentrequirements.html]]]</agent-requirements>
    <branches>[[[branches...|branches.html]]]</branches>
    <builds>[[[builds...|builds.html]]]</builds>
    <investigations>[[[investigations...|investigations.html]]]</investigations>
    <compatibleAgents>[[[agents...|agents.html]]]</compatibleAgents>
    <compatibleCloudImages>[[[cloudImages...|cloudimages.html]]]</compatibleCloudImages>
    <vcsRootInstances>[[[vcs-root-instances...|vcsrootinstances.html]]]</vcsRootInstances>
    <pauseComment>[[[comment...|comment.html]]]</pauseComment>
  </defaultTemplate>
  <buildTypes count="30" href="/app/rest/vcs-roots?locator=count:30,start:20" nextHref="/app/rest/vcs-roots?locator=count:30,start:50" prevHref="/app/rest/vcs-roots?locator=count:20,start:0">
    <buildType>[[[buildType...|buildtype.html]]]</buildType>
  </buildTypes>
  <templates count="30" href="/app/rest/vcs-roots?locator=count:30,start:20" nextHref="/app/rest/vcs-roots?locator=count:30,start:50" prevHref="/app/rest/vcs-roots?locator=count:20,start:0">
    <buildType>[[[buildType...|buildtype.html]]]</buildType>
  </templates>
  <deploymentDashboards count="123" href="string" nextHref="string" prevHref="string">
    <deploymentDashboard>[[[deploymentDashboard...|deploymentdashboard.html]]]</deploymentDashboard>
  </deploymentDashboards>
  <parameters count="123" href="string">
    <property>[[[property...|property.html]]]</property>
  </parameters>
  <vcsRoots count="10" href="/app/rest/vcs-roots?locator=count:10,start:100" nextHref="/app/rest/vcs-roots?locator=count:10,start:110" prevHref="/app/rest/vcs-roots?locator=count:10,start:90">
    <vcs-root>[[[vcs-root...|vcsroot.html]]]</vcs-root>
  </vcsRoots>
  <projectFeatures count="123" href="string">
    <projectFeature>[[[projectFeature...|projectfeature.html]]]</projectFeature>
  </projectFeatures>
  <projects count="39" href="/app/rest/projects?locator=count:30,start:10" nextHref="/app/rest/projects?locator=count:30,start:40" prevHref="/app/rest/projects?locator=count:10,start:0">
    <project>[[[project...|]]]</project>
  </projects>
  <cloudProfiles count="4" href="/app/rest/cloud/profiles" nextHref="/app/rest/cloud/profiles?locator=count:200,start:250" prevHref="/app/rest/cloud/profiles?locator=count:50,start:0">
    <cloudProfile>[[[cloudProfile...|cloudprofile.html]]]</cloudProfile>
  </cloudProfiles>
  <ancestorProjects count="39" href="/app/rest/projects?locator=count:30,start:10" nextHref="/app/rest/projects?locator=count:30,start:40" prevHref="/app/rest/projects?locator=count:10,start:0">
    <project>[[[project...|]]]</project>
  </ancestorProjects>
</project>

{
  "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...|]]]" ],
    "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...|]]]",
    "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" : "locator"
  },
  "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" : 7,
    "deploymentDashboard" : [ "[[[deploymentDashboard...|deploymentdashboard.html]]]" ],
    "prevHref" : "prevHref",
    "href" : "href",
    "nextHref" : "nextHref"
  },
  "links" : {
    "count" : 4,
    "link" : [ "[[[link...|link.html]]]" ]
  },
  "id" : "BuildCacheNodeJS",
  "href" : "/app/rest/projects/id:BuildCacheNodeJS",
  "parentProject" : {
    "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...|]]]",
    "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" : "locator"
  },
  "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" : true,
    "value" : true
  },
  "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...|]]]" ],
    "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" : 1,
    "property" : [ {
      "inherited" : true,
      "name" : "name",
      "type" : "[[[type...|type.html]]]",
      "value" : "value"
    } ],
    "href" : "href"
  },
  "projectFeatures" : {
    "projectFeature" : [ "[[[projectFeature...|projectfeature.html]]]" ],
    "count" : 9,
    "href" : "href"
  },
  "locator" : "locator"
}

Last modified: 15 July 2025