Commit a staged deploy
commit_deployAtomically apply a staging session's files to the live site. Runs preflight + secret/malware scan against the complete staged set; on failure the session stays open and can be re-attempted or aborted. For replace-mode against a site with existing files, requires confirm:"I-want-to-replace-all-files".
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| delete | No | Patch-mode only: site-relative paths to remove from the live site as part of this commit. Useful for renames (write new path via add_files, delete old path here). | |
| dryRun | No | If true, preview what commit would do without touching the live site or scratch dir. Returns the diff (filesDeployed, deletedFiles) plus would-be confirmation gate / preflight outcomes. Skips the secret/malware scan to keep the preview fast — the real commit will still scan. Recommended before any replace-mode commit on a populated site. | |
| 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 | ||
| request_id | No | Server-assigned request correlation id. Quote it when contacting support. | |
| deletedFiles | Yes | ||
| customHeaders | No | Result of the Netlify-style _headers sync: overrides applied to the site's response headers, plus any validation warnings. | |
| filesDeployed | Yes |