PUT /source_control/settings
Creates or updates source control settings for the organization or space. Overwrites any existing settings. Requires the source_control:write scope.
Servers
- https://api.retool.com/api/v2
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
settings |
Object | Yes | |
settings.force_uuid_mapping |
Boolean | No |
When set to true, creates a uuid mapping for protected elements to be used in the source control repo. Defaults to false. |
settings.auto_branch_naming_enabled |
Boolean | No |
When enabled, Retool automatically suggests a branch name on branch creation. Defaults to true. |
settings.version_control_locked |
Boolean | No |
When set to true, creates a read-only instance of Retool, where app editing is disabled. Defaults to false. |
settings.custom_pull_request_template_enabled |
Boolean | No |
When enabled, Retool will use the template specified to create pull requests. Defaults to false. |
settings.custom_pull_request_template |
String | No |
Pull requests created from Retool will use the template specified. |
settings.auto_cleanup_branches_enabled |
Boolean | No |
When set to true, Retool will automatically delete branches after changes are merged if the remote branch no longer exists and there are no uncommitted changes. Defaults to true. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.