Manage Typed Parameters
This article lists REST API requests concerning typed parameters.
List typed parameters | For a project:
GET http://<TeamCity Server host>:<port>/app/rest/projects/<locator>/parameters
For a build configuration:
GET http://<TeamCity Server host>:<port>/app/rest/buildTypes/<locator>/parameters
The information returned is: |
Get details of a specific parameter |
GET http://<TeamCity Server host>:<port>/app/rest/buildTypes/<locator>/parameters/<name>
Accepts/returns plain-text, XML, JSON. Supply the relevant Content-Type header to the request. |
Create a new parameter |
Example of XML for setting a property:
<property name="<parameterName>" value="">
<type rawValue="password"/>
</property>
|
Since TeamCity 9.1, partial updates of a parameter are possible (currently in an experimental state):
Name:
PUT
the same XML or JSON as returned byGET
tohttp://<TeamCity Server host>:<port>/app/rest/buildTypes/<locator>/parameters/NAME
Type:
GET/PUT
accepting XML and JSON as returned byGET
to the URLhttp://<TeamCity Server host>:<port>/app/rest/buildTypes/<locator>/parameters/NAME/type
Type's rawValue:
GET/PUT
accepting plain texthttp://<TeamCity Server host>:<port>/app/rest/buildTypes/<locator>/parameters/NAME/type/rawValue