* See what parameters are required for a method. * Make sure you receive the expected entity in the response. * Find an exact name of the required operation. * A model of a response entity, if applicable For each method, this documentation provides: You can find all methods' descriptions in the _Autogenerated REST API Reference | Methods_ documentation section. _Methods_ are operations available for a given object. Each document in this section lists all available dimensions of a locator with their type and format, and provides examples of the locator usage. The _Autogenerated REST API Reference | Locators_ section contains an autogenerated documentation for locators available in the TeamCity REST API. See the (locators.md) article for a detailed description of this concept. _Locators_ apply filters to the scope of requested objects. * Verify that you use the correct value type. * Check the proper object name of the required entity. * See all the fields of the object to be created. The _Autogenerated REST API Reference | Models_ documentation section lists all object models grouped by the major object they relate to. They specify a data schema for each object: from a project to an agent requirement. _Models_ are blueprints for TeamCity entities. To access the same information via curl, use:Ĭurl -H "Authorization: Bearer " -H "Content-Type: application/xml" -v /app/rest/users -data-binary ""Ĭheck out the _Common Use Cases_ section to see more complex examples. This opens the list of user objects, including their IDs and total number. Open /app/rest/server and find the path to the users endpoint.Įnter the resulting URL in the address bar: /app/rest/users. Let's request the data about all users registered on the server: You can try requesting data via REST API right in your browser, via the address bar. app/rest/entities/.ĭELETE: removes the data at the URL, for example, for. Supported for some entities for URLs like. The functionality is bundled in TeamCity distributions and is developed as open-source plugin. Accepts the same data format as retrieved via the GET request to the same URL. This is the codebase of the JetBrains TeamCity REST API. PUT: updates the data from the submitted payload. When posting XML, be sure to specify the Content-Type: application/xml HTTP header. To create a new entity, one regularly needs to post a single entity data (that is as retrieved via GET) to the. POST: creates the entity from the submitted payload. app/rest/entities/ retrieves a single entity. app/rest/entities usually retrieves a list of entities.
#Teamcity rest api password#
You can use the super user account with REST API: just provide no username and the super user password described here. Read about other supported authentication methods in the extended quide. The TeamCity REST API can be used for integrating applications with TeamCity and for those who want to script interactions with the TeamCity server. To use the REST API, an application makes an HTTP request to the TeamCity server and parses the response. Curl -header "Authorization: Bearer " /app/rest/buildsīased on the provided token, TeamCity will return a payload only if the scope of the request is permitted to the user who owns this token. REST API is an open-source plugin bundled since TeamCity 5.0.
0 kommentar(er)
