### Retrieve Projects href example

Source: https://www.jetbrains.com/help/teamcity/rest/projects.html

Example value for the href property.

```string
/app/rest/projects?locator=count:30,start:10
```

--------------------------------

### Get all plugins

Source: https://www.jetbrains.com/help/teamcity/rest/serverapi.html

Retrieves a list of all plugins installed on the server. Supports optional fields and locator parameters.

```HTTP
GET/app/rest/server/plugins
```

--------------------------------

### Retrieve Projects prevHref example

Source: https://www.jetbrains.com/help/teamcity/rest/projects.html

Example value for the prevHref property.

```string
/app/rest/projects?locator=count:10,start:0
```

--------------------------------

### Retrieve Projects nextHref example

Source: https://www.jetbrains.com/help/teamcity/rest/projects.html

Example value for the nextHref property.

```string
/app/rest/projects?locator=count:30,start:40
```

--------------------------------

### Retrieve Projects count example

Source: https://www.jetbrains.com/help/teamcity/rest/projects.html

Example value for the count property.

```integer
39
```

--------------------------------

### GET /app/rest/deploymentDashboards

Source: https://www.jetbrains.com/help/teamcity/rest/deploymentdashboardapi.html

Get all deployment dashboards.

```APIDOC
## GET /app/rest/deploymentDashboards

### Description
Get all deployment dashboards.

### Method
GET

### Endpoint
/app/rest/deploymentDashboards

### Parameters
#### Query Parameters
- **locator** (string<DeploymentDashboardLocator>) - Optional - Filter dashboards using a locator.
- **fields** (string) - Optional - Fields to include in the response.
```

--------------------------------

### BuildTypes Property Examples

Source: https://www.jetbrains.com/help/teamcity/rest/buildtypes.html

Examples of individual property values for the BuildTypes entity.

```text
30
```

```text
/app/rest/vcs-roots?locator=count:30,start:20
```

```text
/app/rest/vcs-roots?locator=count:30,start:50
```

```text
/app/rest/vcs-roots?locator=count:20,start:0
```

--------------------------------

### GET /app/rest/deploymentDashboards/{deploymentDashboardLocator}/instances/{deploymentInstanceLocator}

Source: https://www.jetbrains.com/help/teamcity/rest/deploymentdashboardapi.html

Get the deployment instance matching the locator.

```APIDOC
## GET /app/rest/deploymentDashboards/{deploymentDashboardLocator}/instances/{deploymentInstanceLocator}

### Description
Get the deployment instance matching the locator.

### Method
GET

### Endpoint
/app/rest/deploymentDashboards/{deploymentDashboardLocator}/instances/{deploymentInstanceLocator}

### Parameters
#### Path Parameters
- **deploymentDashboardLocator** (string<DeploymentDashboardLocator>) - Required - The locator of the dashboard.
- **deploymentInstanceLocator** (string<DeploymentInstanceLocator>) - Required - The locator of the instance.

#### Query Parameters
- **fields** (string) - Optional - Fields to include in the response.
```

--------------------------------

### GET /app/rest/builds/{buildLocator}/sources/files/{fileName}

Source: https://www.jetbrains.com/help/teamcity/rest/buildapi.html

Get a source file of the matching build.

```APIDOC
## GET /app/rest/builds/{buildLocator}/sources/files/{fileName}

### Description
Get a source file of the matching build.

### Method
GET

### Endpoint
/app/rest/builds/{buildLocator}/sources/files/{fileName}

### Parameters
#### Path Parameters
- **buildLocator** (string<BuildLocator>) - Required
- **fileName** (string) - Required
```

--------------------------------

### GET /app/rest/builds/{buildLocator}/output-parameters

Source: https://www.jetbrains.com/help/teamcity/rest/buildapi.html

Get output parameters published by the build.

```APIDOC
## GET /app/rest/builds/{buildLocator}/output-parameters

### Description
Get output parameters published by the build.

### Method
GET

### Endpoint
/app/rest/builds/{buildLocator}/output-parameters

### Parameters
#### Path Parameters
- **buildLocator** (string<BuildLocator>) - Required

#### Query Parameters
- **fields** (string) - Optional

### Response
#### Success Response (200)
- **Response** (Properties) - The output parameters.
```

--------------------------------

### GET /app/rest/deploymentDashboards/{deploymentDashboardLocator}/instances

Source: https://www.jetbrains.com/help/teamcity/rest/deploymentdashboardapi.html

Get deployment instances for a given deployment dashboard.

```APIDOC
## GET /app/rest/deploymentDashboards/{deploymentDashboardLocator}/instances

### Description
Get deployment instances for a given deployment dashboard.

### Method
GET

### Endpoint
/app/rest/deploymentDashboards/{deploymentDashboardLocator}/instances

### Parameters
#### Path Parameters
- **deploymentDashboardLocator** (string<DeploymentDashboardLocator>) - Required - The locator of the dashboard.

#### Query Parameters
- **locator** (string<DeploymentInstanceLocator>) - Optional - Filter instances using a locator.
- **fields** (string) - Optional - Fields to include in the response.
```

--------------------------------

### GET /app/rest/server/plugins

Source: https://www.jetbrains.com/help/teamcity/rest/serverapi.html

Retrieves a list of all plugins installed on the TeamCity server.

```APIDOC
## GET /app/rest/server/plugins

### Description
Get all plugins.

### Method
GET

### Endpoint
/app/rest/server/plugins

### Parameters
#### Query Parameters
- **fields** (string) - Optional - Fields to include in the response
- **locator** (string) - Optional - Locator to filter plugins

### Response
- **Plugins** (object) - The list of plugins
```

--------------------------------

### Start Cloud Instance

Source: https://www.jetbrains.com/help/teamcity/rest/manage-cloud-profiles.html

Initiate a new cloud instance using a POST request with XML or JSON payload.

```HTTP
POST
/app/rest/cloud/instances
```

```XML
<cloudInstance id="profileId:<profileId>,imageId:<imageId>,id:<instanceId>" name="<instanceName>">
	<image id="profileId:<profileId>,id:<imageId>" name="<imageName>"/>
</cloudInstance>
```

```JSON
{
    "id" : "profileId:<profileId>,imageId:<imageId>,id:<instanceId>",
	"name" : "<instanceName>",
	"image": {
    	"id": "profileId:<profileId>,id:<imageId>",
		"name": "<imageName>"
	}
}
```

--------------------------------

### GET /app/rest/projects

Source: https://www.jetbrains.com/help/teamcity/rest/get-project-details.html

Retrieves a list of all projects on the server. Supports pagination using count and start parameters.

```APIDOC
## GET /app/rest/projects

### Description
Retrieves a list of all projects on the server. The response is paginated.

### Method
GET

### Endpoint
/app/rest/projects

### Parameters
#### Query Parameters
- **count** (integer) - Optional - Number of returned projects
- **start** (integer) - Optional - Position of the first returned project
```

--------------------------------

### POST /app/rest/2FA/setup

Source: https://www.jetbrains.com/help/teamcity/rest/manage-2fa.html

Initiates the 2FA setup process for the current user. Returns a secret key, recovery keys, and a UUID for confirmation.

```APIDOC
## POST /app/rest/2FA/setup

### Description
Initiates the 2FA setup process for the current user. Returns a secret key, a set of recovery keys, and a UUID required for confirmation.

### Method
POST

### Endpoint
/app/rest/2FA/setup
```

--------------------------------

### POST /app/rest/cloud/instances

Source: https://www.jetbrains.com/help/teamcity/rest/cloudinstanceapi.html

Starts a new cloud instance.

```APIDOC
## POST /app/rest/cloud/instances

### Description
Start a new cloud instance.

### Method
POST

### Endpoint
/app/rest/cloud/instances

### Parameters
#### Request Body
- **body** (CloudInstance) - Required - The cloud instance configuration

#### Query Parameters
- **fields** (string) - Optional - Fields to include in the response
```

--------------------------------

### GET /app/rest/builds

Source: https://www.jetbrains.com/help/teamcity/rest/locators.html

Retrieves builds using nested locators for filtering by build type and start date conditions.

```APIDOC
## GET /app/rest/builds

### Description
Retrieves a list of builds filtered by a locator string that supports nested dimensions such as buildType and startDate.

### Method
GET

### Endpoint
/app/rest/builds

### Parameters
#### Query Parameters
- **locator** (string) - Required - A locator string defining the filter criteria, supporting nested locators enclosed in parentheses.
```

--------------------------------

### POST /app/rest/deploymentDashboards/{deploymentDashboardLocator}/instances

Source: https://www.jetbrains.com/help/teamcity/rest/deploymentdashboardapi.html

Create a new deployment instance.

```APIDOC
## POST /app/rest/deploymentDashboards/{deploymentDashboardLocator}/instances

### Description
Create a new deployment instance.

### Method
POST

### Endpoint
/app/rest/deploymentDashboards/{deploymentDashboardLocator}/instances

### Parameters
#### Path Parameters
- **deploymentDashboardLocator** (string<DeploymentDashboardLocator>) - Required - The locator of the dashboard.

#### Request Body
- **body** (DeploymentInstance) - Required - The instance object to create.
```

--------------------------------

### LicenseKeys Schema Representations

Source: https://www.jetbrains.com/help/teamcity/rest/licensekeys.html

XML and JSON schema examples for the LicenseKeys entity. Use these structures when performing GET or POST requests to the TeamCity REST API.

```xml
<licenseKeys count="123" href="string">
  <licenseKey>licenseKey...</licenseKey>
</licenseKeys>
```

```json
{
  "licenseKey" : [ {
    "rawType" : "rawType",
    "unlimitedBuildTypes" : true,
    "obsolete" : true,
    "active" : true,
    "unlimitedAgents" : true,
    "type" : "evaluation",
    "unlimitedPipelines" : true,
    "agents" : 0,
    "valid" : true,
    "maintenanceEndDate" : "maintenanceEndDate",
    "expired" : true,
    "servers" : 4,
    "pipelines" : 7,
    "buildTypes" : 0,
    "key" : "key",
    "expirationDate" : "expirationDate",
    "errorDetails" : "errorDetails"
  } ],
  "count" : 4,
  "href" : "href"
}
```

--------------------------------

### GET /app/rest/roles

Source: https://www.jetbrains.com/help/teamcity/rest/roleapi.html

Get all roles.

```APIDOC
## GET /app/rest/roles

### Description
Get all roles.

### Method
GET

### Endpoint
/app/rest/roles

### Parameters
#### Query Parameters
- **fields** (string) - Optional - Fields to include in the response.

### Response
#### Success Response (200)
- **Roles** (object) - A list of roles.
```

--------------------------------

### Start Server Backup

Source: https://www.jetbrains.com/help/teamcity/rest/manage-data-backup.html

Initiates a backup process by sending a POST request to the server endpoint with specified backup scope parameters.

```HTTP
POST
/app/rest/server/backup?includeConfigs=true&includeDatabase=true&includeBuildLogs=true&fileName=MyCustomBackup.zip
```

--------------------------------

### GET /app/rest/changes

Source: https://www.jetbrains.com/help/teamcity/rest/changeapi.html

Get all changes.

```APIDOC
## GET /app/rest/changes

### Description
Get all changes.

### Method
GET

### Endpoint
/app/rest/changes

### Parameters
#### Query Parameters
- **locator** (string<ChangeLocator>) - Optional - Change locator
- **fields** (string) - Optional - Fields to include

### Response
#### Success Response (200)
- **Changes** (object) - A list of changes
```

--------------------------------

### DeploymentInstance Schema Examples

Source: https://www.jetbrains.com/help/teamcity/rest/deploymentinstance.html

XML and JSON representations of the DeploymentInstance object structure.

```xml
<deploymentInstance attributes="Map{}" currentState="string" id="string">
  <deploymentStateEntries count="123">
    <historyFromPosted>DeploymentHistory...</historyFromPosted>
    <deploymentStateEntry>deploymentStateEntry...</deploymentStateEntry>
  </deploymentStateEntries>
  <deploymentDashboard id="string" name="string">
    <deploymentInstances>deploymentInstances...</deploymentInstances>
    <project>project...</project>
  </deploymentDashboard>
</deploymentInstance>
```

```json
{
  "deploymentDashboard" : "deploymentDashboard...",
  "attributes" : {
    "key" : "attributes"
  },
  "id" : "id",
  "currentState" : "IN_PROGRESS",
  "deploymentStateEntries" : "deploymentStateEntries..."
}
```

--------------------------------

### GET /app/rest/server

Source: https://www.jetbrains.com/help/teamcity/rest/serverapi.html

Get the server info.

```APIDOC
## GET /app/rest/server

### Description
Get the server info.

### Method
GET

### Endpoint
/app/rest/server

### Parameters
#### Query Parameters
- **fields** (string) - Optional - Fields to include in the response.
```

--------------------------------

### Cleanup Configuration Examples

Source: https://www.jetbrains.com/help/teamcity/rest/cleanup.html

Example XML and JSON representations of the cleanup settings object.

```xml
<cleanup enabled="true" maxCleanupDuration="120">
  <daily hour="3" minute="30"/>
  <cron day="?" dayWeek="JAN" hour="0" minute="30" month="JAN"/>
</cleanup>
```

```json
{
  "cron" : {
    "hour" : "0",
    "month" : "JAN",
    "dayWeek" : "JAN",
    "day" : "?",
    "minute" : "30"
  },
  "daily" : {
    "hour" : 3,
    "minute" : 30
  },
  "maxCleanupDuration" : 120,
  "enabled" : true
}
```

--------------------------------

### POST /app/rest/deploymentDashboards/{deploymentDashboardLocator}/instances/{deploymentInstanceLocator}

Source: https://www.jetbrains.com/help/teamcity/rest/deploymentdashboardapi.html

Report a new deployment for instance.

```APIDOC
## POST /app/rest/deploymentDashboards/{deploymentDashboardLocator}/instances/{deploymentInstanceLocator}

### Description
Report a new deployment for instance.

### Method
POST

### Endpoint
/app/rest/deploymentDashboards/{deploymentDashboardLocator}/instances/{deploymentInstanceLocator}

### Parameters
#### Path Parameters
- **deploymentDashboardLocator** (string<DeploymentDashboardLocator>) - Required - The locator of the dashboard.
- **deploymentInstanceLocator** (string<DeploymentInstanceLocator>) - Required - The locator of the instance.

#### Request Body
- **body** (DeploymentStateEntry) - Required - The deployment state entry.
```

--------------------------------

### GET /app/rest/buildQueue

Source: https://www.jetbrains.com/help/teamcity/rest/buildqueueapi.html

Get all queued builds.

```APIDOC
## GET /app/rest/buildQueue

### Description
Get all queued builds.

### Method
GET

### Endpoint
/app/rest/buildQueue

### Parameters
#### Query Parameters
- **locator** (string<BuildQueueLocator>) - Optional - BuildQueueLocator
- **fields** (string) - Optional - fields

### Response
#### Success Response (200)
- **Builds** (Builds) - List of queued builds
```

--------------------------------

### GET /app/rest/roles/id:{id}

Source: https://www.jetbrains.com/help/teamcity/rest/roleapi.html

Get a role with specified id.

```APIDOC
## GET /app/rest/roles/id:{id}

### Description
Get a role with specified id.

### Method
GET

### Endpoint
/app/rest/roles/id:{id}

### Parameters
#### Path Parameters
- **id** (string) - Required - The ID of the role.

#### Query Parameters
- **fields** (string) - Optional - Fields to include in the response.

### Response
#### Success Response (200)
- **Role** (object) - The requested role.
```

--------------------------------

### GET /app/rest/changes/{changeLocator}

Source: https://www.jetbrains.com/help/teamcity/rest/changeapi.html

Get change matching the locator.

```APIDOC
## GET /app/rest/changes/{changeLocator}

### Description
Get change matching the locator.

### Method
GET

### Endpoint
/app/rest/changes/{changeLocator}

### Parameters
#### Path Parameters
- **changeLocator** (string<ChangeLocator>) - Required - The change locator

#### Query Parameters
- **fields** (string) - Optional - Fields to include

### Response
#### Success Response (200)
- **Change** (object) - The change object
```

--------------------------------

### Retrieve Build Steps

Source: https://www.jetbrains.com/help/teamcity/rest/manage-build-configuration-details.html

Endpoint for fetching all build steps for a specific build configuration.

```HTTP
GET
/app/rest/buildTypes/<buildTypeLocator>/steps
```

--------------------------------

### GET /app/rest/buildQueue/{queuedBuildLocator}

Source: https://www.jetbrains.com/help/teamcity/rest/buildqueueapi.html

Get a queued matching build.

```APIDOC
## GET /app/rest/buildQueue/{queuedBuildLocator}

### Description
Get a queued matching build.

### Method
GET

### Endpoint
/app/rest/buildQueue/{queuedBuildLocator}

### Parameters
#### Path Parameters
- **queuedBuildLocator** (string<BuildQueueLocator>) - Required - BuildQueueLocator

#### Query Parameters
- **fields** (string) - Optional - fields

### Response
#### Success Response (200)
- **Build** (Build) - The build
```

--------------------------------

### GET /app/rest/users/{userLocator}/{field}

Source: https://www.jetbrains.com/help/teamcity/rest/userapi.html

Get a field of the matching user.

```APIDOC
## GET /app/rest/users/{userLocator}/{field}

### Description
Get a field of the matching user.

### Method
GET

### Endpoint
/app/rest/users/{userLocator}/{field}

### Parameters
#### Path Parameters
- **userLocator** (string<UserLocator>) - Required
- **field** (string) - Required
```

--------------------------------

### Define Build Step Payload

Source: https://www.jetbrains.com/help/teamcity/rest/manage-build-configuration-details.html

Example payload for a command line build step.

```XML
<steps>
  <step name="myCommandLineStep" type="simpleRunner">
    <properties count="4">
	  <property name="script.content" value="echo 'Hello World!'"/>
    </properties>
  </step>
</steps>
```

```JSON
{
	"name": "myCommandLineStep",
	"type": "simpleRunner",
	"properties": {
		"property": [
			{
				"name": "script.content",
				"value": "echo 'Hello World!'"
			}
		]
	}
}
```

--------------------------------

### Setup 2FA for current user

Source: https://www.jetbrains.com/help/teamcity/rest/manage-2fa.html

Initiates the 2FA setup process for the authenticated user, returning a secret key, recovery keys, and a confirmation UUID.

```http
POST
/app/rest/2FA/setup
```

--------------------------------

### GET /app/rest/users/{userLocator}/properties

Source: https://www.jetbrains.com/help/teamcity/rest/userapi.html

Get all properties of the matching user.

```APIDOC
## GET /app/rest/users/{userLocator}/properties

### Description
Get all properties of the matching user.

### Method
GET

### Endpoint
/app/rest/users/{userLocator}/properties

### Parameters
#### Path Parameters
- **userLocator** (string<UserLocator>) - Required

#### Query Parameters
- **fields** (string) - Optional

### Response
#### Success Response (200)
- **Properties** (object) - The properties of the user.
```

--------------------------------

### List all build configurations

Source: https://www.jetbrains.com/help/teamcity/rest/manage-build-configuration-details.html

Retrieves a list of all build configurations available on the server.

```HTTP
GET
/app/rest/buildTypes
```

--------------------------------

### GET /app/rest/builds/{buildLocator}/status

Source: https://www.jetbrains.com/help/teamcity/rest/buildapi.html

Get status of the matching build.

```APIDOC
## GET /app/rest/builds/{buildLocator}/status

### Description
Get status of the matching build.

### Method
GET

### Endpoint
/app/rest/builds/{buildLocator}/status

### Parameters
#### Path Parameters
- **buildLocator** (string) - Required - BuildLocator

### Response
#### Success Response (200)
- **body** (string) - The build status
```

--------------------------------

### GET /app/rest/builds/{buildLocator}/number

Source: https://www.jetbrains.com/help/teamcity/rest/buildapi.html

Get the number of the matching build.

```APIDOC
## GET /app/rest/builds/{buildLocator}/number

### Description
Get the number of the matching build.

### Method
GET

### Endpoint
/app/rest/builds/{buildLocator}/number

### Parameters
#### Path Parameters
- **buildLocator** (string<BuildLocator>) - Required

### Response
#### Success Response (200)
- **Response** (string) - The build number.
```

--------------------------------

### Project JSON Object Model

Source: https://www.jetbrains.com/help/teamcity/rest/project.html

Example of the JSON structure for a project, detailing properties like VCS roots, build templates, and parent project references.

```json
{
  "virtual" : false,
  "parentProjectName" : "S3 Buckets Test",
  "vcsRoots" : {
    "count" : 10,
    "vcs-root" : [ "vcs-root..." ],
    "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...",
    "paused" : false,
    "output-parameters" : "properties...",
    "description" : "Deploys artifacts to the public registry",
    "project" : "project...",
    "investigations" : "investigations...",
    "templateFlag" : false,
    "type" : "regular",
    "uuid" : "8e7eafb8-321b-456e-84db-e73714c8fa3f",
    "projectInternalId" : "project762",
    "internalId" : "bt1057",
    "features" : "features...",
    "builds" : "builds...",
    "links" : "links...",
    "id" : "Deployments_DeployToGlobal",
    "href" : "/app/rest/buildTypes/id:Deployments_DeployToGlobal",
    "compatibleCloudImages" : "cloudImages...",
    "settings" : "properties...",
    "vcsRootInstances" : "vcs-root-instances...",
    "templates" : "buildTypes...",
    "artifact-dependencies" : "artifact-dependencies...",
    "compatibleAgents" : "agents...",
    "pauseComment" : "comment...",
    "triggers" : "triggers...",
    "branches" : "branches...",
    "steps" : "steps...",
    "externalStatusAllowed" : false,
    "agent-requirements" : "agent-requirements...",
    "webUrl" : "https://localhost:8111/buildConfiguration/Deployments_DeployToGlobal?mode=builds",
    "inherited" : false,
    "snapshot-dependencies" : "snapshot-dependencies...",
    "name" : "Deploy To Global",
    "vcs-root-entries" : "vcs-root-entries...",
    "projectName" : "Deployments",
    "projectId" : "Deployments",
    "parameters" : "properties...",
    "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..." ],
    "nextHref" : "/app/rest/cloud/profiles?locator=count:200,start:250"
  },
  "internalId" : "project302",
  "archived" : false,
  "parentProjectId" : "S3BucketsTest",
  "deploymentDashboards" : {
    "count" : 7,
    "deploymentDashboard" : [ "deploymentDashboard..." ],
    "prevHref" : "prevHref",
    "href" : "href",
    "nextHref" : "nextHref"
  },
  "links" : {
    "link" : [ "link..." ],
    "count" : 4
  },
  "id" : "BuildCacheNodeJS",
  "href" : "/app/rest/projects/id:BuildCacheNodeJS",
  "parentProject" : {
    "virtual" : false,
    "parentProjectName" : "S3 Buckets Test",
    "vcsRoots" : "vcs-roots...",
    "projects" : "projects...",
    "defaultTemplate" : "buildType...",
    "description" : "This subproject contains configurations that carry out delivery jobs",
    "uuid" : "37dccab8-ddf9-4f81-a1ad-7815f0e841e1",
    "parentProjectInternalId" : "project82",
    "cloudProfiles" : "cloudProfiles...",
    "internalId" : "project302",
    "archived" : false,
    "parentProjectId" : "S3BucketsTest",
    "deploymentDashboards" : "deploymentDashboards...",
    "links" : "links...",
    "id" : "BuildCacheNodeJS",
    "href" : "/app/rest/projects/id:BuildCacheNodeJS",
    "parentProject" : "project...",
    "templates" : "buildTypes...",
    "readOnlyUI" : "StateField...",
    "webUrl" : "https://localhost:8111/project.html?projectId=BuildAndDeploy",
    "buildTypes" : "buildTypes...",
    "name" : "Build Cache — NodeJS",
    "ancestorProjects" : "projects...",
    "parameters" : "properties...",
    "projectFeatures" : "projectFeatures...",
    "locator" : "locator"
  },
  "templates" : {
    "buildType" : [ "buildType..." ],
    "count" : 30,
    "prevHref" : "/app/rest/vcs-roots?locator=count:20,start:0"
```

--------------------------------

### GET /app/rest/deploymentDashboards/{deploymentDashboardLocator}

Source: https://www.jetbrains.com/help/teamcity/rest/deploymentdashboardapi.html

Get the deployment dashboard matching the locator.

```APIDOC
## GET /app/rest/deploymentDashboards/{deploymentDashboardLocator}

### Description
Get the deployment dashboard matching the locator.

### Method
GET

### Endpoint
/app/rest/deploymentDashboards/{deploymentDashboardLocator}

### Parameters
#### Path Parameters
- **deploymentDashboardLocator** (string<DeploymentDashboardLocator>) - Required - The locator of the dashboard.

#### Query Parameters
- **fields** (string) - Optional - Fields to include in the response.
```

--------------------------------

### UserAvatars Property Examples

Source: https://www.jetbrains.com/help/teamcity/rest/useravatars.html

Examples of relative URL strings for different avatar sizes.

```text
/app/rest/avatars/id:1/20/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png
```

```text
/app/rest/avatars/id:1/28/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png
```

```text
/app/rest/avatars/id:1/32/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png
```

```text
/app/rest/avatars/id:1/40/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png
```

```text
/app/rest/avatars/id:1/56/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png
```

```text
/app/rest/avatars/id:1/64/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png
```

```text
/app/rest/avatars/id:1/80/avatar.a0b4af01-0211-4216-b2de-c295b282b4b5.png
```

--------------------------------

### GET /app/rest/changes/{changeLocator}/{field}

Source: https://www.jetbrains.com/help/teamcity/rest/changeapi.html

Get a field of the matching change.

```APIDOC
## GET /app/rest/changes/{changeLocator}/{field}

### Description
Get a field of the matching change.

### Method
GET

### Endpoint
/app/rest/changes/{changeLocator}/{field}

### Parameters
#### Path Parameters
- **changeLocator** (string<ChangeLocator>) - Required - The change locator
- **field** (string) - Required - The field name

### Response
#### Success Response (200)
- **string** (string) - The value of the field
```

--------------------------------

### Requesting Projects via Path and Query Locators

Source: https://www.jetbrains.com/help/teamcity/rest/locators.html

Demonstrates the difference between using path-based locators for a single result and query-based locators for a collection.

```http
GET https://<server-url>/app/rest/projects/name:Build
```

```http
GET https://<server-url>/app/rest/projects?locator=name:Build
```

--------------------------------

### GET /app/rest/changes/{changeLocator}/issues

Source: https://www.jetbrains.com/help/teamcity/rest/changeapi.html

Get issues of the matching change.

```APIDOC
## GET /app/rest/changes/{changeLocator}/issues

### Description
Get issues of the matching change.

### Method
GET

### Endpoint
/app/rest/changes/{changeLocator}/issues

### Parameters
#### Path Parameters
- **changeLocator** (string<ChangeLocator>) - Required - The change locator

### Response
#### Success Response (200)
- **Issues** (object) - A list of issues
```

--------------------------------

### Create Project Payload

Source: https://www.jetbrains.com/help/teamcity/rest/create-and-delete-projects.html

Example payloads for creating a project in XML or JSON format.

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

```JSON
{
    "parentProject": {
        "locator": "locator"
    },
    "name": "name",
    "id": "id",
    "copyAllAssociatedSettings": true
}
```

--------------------------------

### GET /app/rest/changes/{changeLocator}/duplicates

Source: https://www.jetbrains.com/help/teamcity/rest/changeapi.html

Get duplicates of the matching change.

```APIDOC
## GET /app/rest/changes/{changeLocator}/duplicates

### Description
Get duplicates of the matching change.

### Method
GET

### Endpoint
/app/rest/changes/{changeLocator}/duplicates

### Parameters
#### Path Parameters
- **changeLocator** (string<ChangeLocator>) - Required - The change locator

#### Query Parameters
- **fields** (string) - Optional - Fields to include

### Response
#### Success Response (200)
- **Changes** (object) - A list of duplicate changes
```

--------------------------------

### GET /app/rest/changes/{changeLocator}/attributes

Source: https://www.jetbrains.com/help/teamcity/rest/changeapi.html

Get attributes of the matching change.

```APIDOC
## GET /app/rest/changes/{changeLocator}/attributes

### Description
Get attributes of the matching change.

### Method
GET

### Endpoint
/app/rest/changes/{changeLocator}/attributes

### Parameters
#### Path Parameters
- **changeLocator** (string<ChangeLocator>) - Required - The change locator

#### Query Parameters
- **fields** (string) - Optional - Fields to include

### Response
#### Success Response (200)
- **Entries** (object) - The attributes entries
```

--------------------------------

### POST /app/rest/deploymentDashboards

Source: https://www.jetbrains.com/help/teamcity/rest/deploymentdashboardapi.html

Create a new deployment dashboard.

```APIDOC
## POST /app/rest/deploymentDashboards

### Description
Create a new deployment dashboard.

### Method
POST

### Endpoint
/app/rest/deploymentDashboards

### Parameters
#### Request Body
- **body** (DeploymentDashboard) - Required - The dashboard object to create.
```

--------------------------------

### GET /app/rest/agents/{agentLocator}/{field}

Source: https://www.jetbrains.com/help/teamcity/rest/agentapi.html

Get a field of the matching agent.

```APIDOC
## GET /app/rest/agents/{agentLocator}/{field}

### Description
Get a field of the matching agent.

### Method
GET

### Endpoint
/app/rest/agents/{agentLocator}/{field}

### Parameters
#### Path Parameters
- **agentLocator** (string) - Required - AgentLocator
- **field** (string) - Required

### Response
#### Success Response (200)
- **value** (string) - The value of the requested field.
```

--------------------------------

### List Build Problems

Source: https://www.jetbrains.com/help/teamcity/rest/manage-tests-and-build-problems.html

Retrieve build problems using a locator. The example shows filtering by a specific build ID.

```HTTP
GET
/app/rest/problemOccurrences?locator=<problemOccurrenceLocator>
```

```HTTP
GET
/app/rest/problemOccurrences?locator=build:(id:999)
```

--------------------------------

### ServerGlobalSettings Schema Examples

Source: https://www.jetbrains.com/help/teamcity/rest/serverglobalsettings.html

Full schema representation of the server global settings object in XML and JSON formats.

```xml
<serverGlobalSettings artifactDirectories="system/artifacts\r\nsystem/bin/teamcity/artifacts" artifactsDomainIsolation="true" artifactsUrl="https://my-artifacts-server.labs.gg" defaultExecutionTimeout="0" defaultQuietPeriod="60" defaultVCSCheckInterval="60" encryptionKey="string" enforceDefaultVCSCheckInterval="false" maxArtifactSize="314572800" maxArtifactsNumber="1000" rootUrl="https://localhost:8111&quot;" useEncryption="false"/>
```

```json
{
  "artifactsUrl" : "https://my-artifacts-server.labs.gg",
  "defaultQuietPeriod" : 60,
  "defaultVCSCheckInterval" : 60,
  "artifactDirectories" : "system/artifacts\\r\\nsystem/bin/teamcity/artifacts",
  "useEncryption" : false,
  "maxArtifactsNumber" : 1000,
  "enforceDefaultVCSCheckInterval" : false,
  "encryptionKey" : "encryptionKey",
  "defaultExecutionTimeout" : 0,
  "artifactsDomainIsolation" : true,
  "maxArtifactSize" : 314572800,
  "rootUrl" : "https://localhost:8111\""
}
```

--------------------------------

### Get all build configurations order

Source: https://www.jetbrains.com/help/teamcity/rest/projectapi.html

Retrieves the custom order of build configurations for a given project.

```http
GET/app/rest/projects/{projectLocator}/order/buildTypes
```

--------------------------------

### GET /app/rest/users/{userLocator}/tokens

Source: https://www.jetbrains.com/help/teamcity/rest/userapi.html

Get all authentication tokens of the matching user.

```APIDOC
## GET /app/rest/users/{userLocator}/tokens

### Description
Get all authentication tokens of the matching user.

### Method
GET

### Endpoint
/app/rest/users/{userLocator}/tokens

### Parameters
#### Path Parameters
- **userLocator** (string<UserLocator>) - Required

#### Query Parameters
- **fields** (string) - Optional
```

--------------------------------

### List ordered build configurations and subprojects

Source: https://www.jetbrains.com/help/teamcity/rest/get-project-details.html

Retrieves build configurations or subprojects in their custom UI-defined order.

```HTTP
GET
/app/rest/projects/<projectLocator>/order/buildTypes
```

```HTTP
GET
/app/rest/projects/<projectLocator>/order/projects
```

--------------------------------

### BuildCancelRequest Schema Examples

Source: https://www.jetbrains.com/help/teamcity/rest/buildcancelrequest.html

Examples of the BuildCancelRequest object structure in XML and JSON formats.

```xml
<buildCancelRequest comment="Started by mistake" readdIntoQueue="false"/>
```

```json
{
  "comment" : "Started by mistake",
  "readdIntoQueue" : false
}
```

--------------------------------

### GET /app/rest/users/{userLocator}/properties/{name}

Source: https://www.jetbrains.com/help/teamcity/rest/userapi.html

Get a property of the matching user.

```APIDOC
## GET /app/rest/users/{userLocator}/properties/{name}

### Description
Get a property of the matching user.

### Method
GET

### Endpoint
/app/rest/users/{userLocator}/properties/{name}

### Parameters
#### Path Parameters
- **userLocator** (string<UserLocator>) - Required
- **name** (string) - Required

### Response
#### Success Response (200)
- **string** (string) - The value of the property.
```

--------------------------------

### GET /app/rest/vcs-roots/{vcsRootLocator}/{field}

Source: https://www.jetbrains.com/help/teamcity/rest/vcsrootapi.html

Get a field of the matching VCS root.

```APIDOC
## GET /app/rest/vcs-roots/{vcsRootLocator}/{field}

### Description
Get a field of the matching VCS root.

### Method
GET

### Endpoint
/app/rest/vcs-roots/{vcsRootLocator}/{field}

### Parameters
#### Path Parameters
- **vcsRootLocator** (string<VcsRootLocator>) - Required - VCS root locator
- **field** (string) - Required - Field name

### Response
#### Success Response (200)
- **value** (string) - Field value
```

--------------------------------

### Manage versioned settings tokens

Source: https://www.jetbrains.com/help/teamcity/rest/manage-vcs-settings.html

Returns a list of tokens. Supports POST to create new tokens and DELETE to remove unused tokens.

```HTTP
GET
/app/rest/projects/{locator}/versionedSettings/tokens
```

--------------------------------

### POST /app/rest/cloud/instances/{instanceLocator}/actions/forceStop

Source: https://www.jetbrains.com/help/teamcity/rest/cloudinstanceapi.html

Terminates an existing cloud instance immediately.

```APIDOC
## POST /app/rest/cloud/instances/{instanceLocator}/actions/forceStop

### Description
Terminates existing cloud instance immediately.

### Method
POST

### Endpoint
/app/rest/cloud/instances/{instanceLocator}/actions/forceStop

### Parameters
#### Path Parameters
- **instanceLocator** (string) - Required - The locator of the instance
```

--------------------------------

### GET /app/rest/vcs-roots/{vcsRootLocator}/properties

Source: https://www.jetbrains.com/help/teamcity/rest/vcsrootapi.html

Get all properties of the matching VCS root.

```APIDOC
## GET /app/rest/vcs-roots/{vcsRootLocator}/properties

### Description
Get all properties of the matching VCS root.

### Method
GET

### Endpoint
/app/rest/vcs-roots/{vcsRootLocator}/properties

### Parameters
#### Path Parameters
- **vcsRootLocator** (string<VcsRootLocator>) - Required - VCS root locator

#### Query Parameters
- **fields** (string) - Optional - Fields to include

### Response
#### Success Response (200)
- **Properties** (object) - List of properties
```

--------------------------------

### GET /app/rest/projects/{projectLocator}/defaultTemplate

Source: https://www.jetbrains.com/help/teamcity/rest/projectapi.html

Get the default template of the matching project.

```APIDOC
## GET /app/rest/projects/{projectLocator}/defaultTemplate

### Description
Get the default template of the matching project.

### Method
GET

### Endpoint
/app/rest/projects/{projectLocator}/defaultTemplate

### Parameters
#### Path Parameters
- **projectLocator** (string<ProjectLocator>) - Required

#### Query Parameters
- **fields** (string) - Optional

### Response
#### Success Response (200)
- **BuildType** (object) - The default template of the project.
```