How to clear the checkout directory when triggering the build with REST API

October 23, 2026 05:41 Updated

Question

When running a custom build from the UI, it is possible to delete all files in the checkout directory before the build using the corresponding option. Similar to this option, can the checkout directory be cleaned up when triggering the build using the REST API?

Answer

This can be achieved by adding the triggeringOptions to the build payload and specifying cleanSources="true" in it. Example:

<build> 
  <triggeringOptions cleanSources="true"/>
  <buildType id="buildConfID"/>
</build>