Commit a staged deploy
commit_deployPublish a begin_deploy session's staged files to the live site in one atomic step, after a secret and malware scan of the complete set (on failure the session stays open to retry or abort). Replace mode on a site that has files needs confirm:"I-want-to-replace-all-files". After a timeout or dropped connection, call it again with the same deployId: it returns the running or finished commit instead of starting a second one. Use commit_deploy only to finish a begin_deploy session; deploy_site and update_site publish in one call.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"deployId": "<deployId>"
},
"name": "commit_deploy"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| delete | No | Patch mode only: site-relative paths to remove from the live site in this commit (e.g. the old path of a renamed file). | |
| dryRun | No | Preview the commit (filesDeployed, deletedFiles, confirm and plan checks) without touching the live site. Skips the secret and malware scan, which the real commit still runs. | |
| confirm | No | Required only for replace-mode commits against a site that already has files. Pass exactly "I-want-to-replace-all-files" to acknowledge that the live files will be deleted and replaced with the staged set. | |
| deployId | Yes | Session id returned by begin_deploy. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | ||
| mode | Yes | ||
| dryRun | No | True if this was a dry-run; nothing was committed. | |
| siteId | Yes | ||
| deployId | Yes | ||
| warnings | Yes | ||
| manageUrl | No | Dashboard page where the user manages this site (domains, versions, settings). Omitted on dry runs. | |
| deletedFiles | Yes | ||
| customDomains | No | Custom domains of this site and the team's custom-domain allowance; null when they could not be read. Omitted on dry runs. | |
| customHeaders | No | Result of syncing the _headers file in the site root (site-wide /* response headers). | |
| filesDeployed | Yes |