Child pages
  • REST API Plugin

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Since 8.0 <artifact relative name> supports archived files, so "!/" delimiter can be used.
Samples:
  GET http://teamcity:8111/httpAuth/app/rest/builds/id:100/artifacts/children/my-great-tool-0.1.jar\!/META-INF
  GET http://teamcity:8111/httpAuth/app/rest/builds/id:100/artifacts/metadata/my-great-tool-0.1.jar\!/META-INF/MANIFEST.MF
  GET http://teamcity:8111/httpAuth/app/rest/builds/id:100/artifacts/metadata/my-great-tool-0.1.jar!/lib/commons-logging-1.1.1.jar!/META-INF/MANIFEST.MF
  GET http://teamcity:8111/httpAuth/app/rest/builds/id:100/artifacts/content/my-great-tool-0.1.jar!/lib/commons-logging-1.1.1.jar!/META-INF/MANIFEST.MF

If you download the artifacts from within a TeamCity build, consider using teamcity.auth.userId/teamcity.auth.password system properties as credentials for the download artifacts request: this way TeamCity will have a way to record that one build used artifacts of another and will display that on build's Dependencies tab.

...

where
"USER" and "PASSWORD" - credentials of a valid TeamCity user (that you can login with)
"teamcity:8111" - TeamCity server URL
"USERNAME" - username of the user to make the system administrator
"XXX-YYY-...-ZZZ" - the authentication token retrieved earlier





























/ option ON

  • you are logged in to the TeamCity server in the same browser and you have permission to view the build configuration referenced

CCTray

Since TeamCity 7.0
CCTray-compatible XML is available via http://teamcity:8111/httpAuth/app/rest/cctray/projects.xml
Without authentication (only build configurations available for guest user): http://teamcity:8111/guestAuth/app/rest/cctray/projects.xml.

CORS Support

Since TeamCity 7.1, REST can be configured to allow Cross-origin requests.
If you want to allow requests from a page loaded from specific domain, add the domain to comma-separated internal property rest.cors.origins.
e.g.

rest.cors.origins=google.com,myinternalwebpage.org.com

If that does not work, please enable debug logging and investigate the log lines which should be pretty descriptive.

Logging

See logs\teamcity-rest.log for REST-related logging. You can also enable debug logging in the server logs for