POST /source_control/test_deploy
Attempts a test deployment (no permanent changes) using the provided commit SHA to determine whether the commit is valid. Requires the source_control:test_deploy 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 |
|---|---|---|---|
deploy_params |
Object | Yes | |
deploy_params.branch_name |
String | No |
The branch the commit is on. When provided, the clone targets this branch for faster checkout. Falls back to the default branch if omitted. |
deploy_params.is_full_sync |
Boolean | No | |
deploy_params.commit_sha |
String | Yes |
The full commit SHA to dry deploy |
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.