TeamCity REST API Reference 2026.2 Help

Mute

Represents a mute — a suppression rule that prevents specific test failures or build problems from affecting the build status. In TeamCity, both tests and build problems follow an original + occurrences model: a Test or Problem is the unique entity (identified by name or type + identity), and each time it runs or is encountered it creates a TestOccurrence or ProblemOccurrence. A mute targets the original Test or Problem within a specified scope of build configurations, so all future occurrences within that scope are silenced. Muted failures are still recorded, but they do not turn the build red.

Properties

id

The ID of this mute.

href

The relative link (without the TeamCity server URL) used to retrieve this object.

assignment

Details about who created the mute and when.

scope

The build configurations scope in which the mute is active.

target

The tests or build problems that are muted.

resolution

The resolution policy that determines when the mute is automatically lifted.

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.

<mute href="/app/rest/mutes/id:1" id="1"> <assignment text="Muted due to known flakiness" timestamp="20260401T013826+0200"> <user>[[[user...|user.html]]]</user> </assignment> <scope> <project>[[[project...|project.html]]]</project> <buildTypes>[[[buildTypes...|buildtypes.html]]]</buildTypes> <buildType>[[[buildType...|buildtype.html]]]</buildType> </scope> <target anyProblem="true"> <tests>[[[tests...|tests.html]]]</tests> <problems>[[[problems...|problems.html]]]</problems> </target> <resolution time="20240101T120000+0000" type="whenFixed"/> </mute>
{ "assignment" : { "text" : "Muted due to known flakiness", "user" : "[[[user...|user.html]]]", "timestamp" : "20260401T013826+0200" }, "scope" : { "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" }, "buildType" : { "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" }, "project" : { "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" } }, "id" : 1, "href" : "/app/rest/mutes/id:1", "resolution" : { "time" : "20240101T120000+0000", "type" : "whenFixed" }, "target" : { "tests" : { "test" : [ { "testOccurrences" : "[[[testOccurrences...|testoccurrences.html]]]", "name" : "com.mycompany.app.AppTest.testAppMessage", "investigations" : "[[[investigations...|investigations.html]]]", "parsedTestName" : "[[[ParsedTestName...|parsedtestname.html]]]", "id" : "123456789", "href" : "/app/rest/tests/id:123456789", "mutes" : "[[[mutes...|mutes.html]]]", "locator" : "id:123456789" } ], "count" : 10, "myTestCounters" : { "all" : 15, "duration" : 12345, "ignored" : 1, "newFailed" : 2, "success" : 10, "failed" : 3, "muted" : 1 }, "prevHref" : "/app/rest/tests?locator=start:0", "nextHref" : "/app/rest/tests?locator=start:100" }, "anyProblem" : true, "problems" : { "problem" : [ { "problemOccurrences" : "[[[problemOccurrences...|problemoccurrences.html]]]", "identity" : "simpleRunnerfail_build_127", "description" : "description", "investigations" : "[[[investigations...|investigations.html]]]", "id" : "211", "href" : "/app/rest/problems/id:211", "type" : "TC_EXIT_CODE", "mutes" : "[[[mutes...|mutes.html]]]", "locator" : "id:211" } ], "count" : 1, "prevHref" : "/app/rest/problems?locator=start:0", "nextHref" : "/app/rest/problems?locator=start:100" } } }
Last modified: 18 August 2026