Metadata API Developer Guide

Introduction to Metadata API
Using Metadata API
Deploying and Retrieving Metadata
CRUD-Based Metadata Development
REST Resources
Deploy Metadata with Apex Testing Using REST
Check the Status of Your Deployment Using REST Resources
Deploy a Recently Validated Component Set Without Tests
Cancel a Deployment in Progress Using REST
Deploy Metadata with REST API in Salesforce CLI
Error Handling
Metadata API Context MCP Tool (Beta)
Reference
Appendices
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Cancel a Deployment in Progress Using REST

You can request a cancellation of a deployment that's already in progress. Make the cancellation request by patching the status of an ongoing deployRequest. The cancellation is processed asynchronously. For API versions 65.0 and higher, deployments with a status of Finalizing Deploy, can't be cancelled. For API versions below 65.0, attempts to cancel a deployment may fail if the deployment has started committing data. Alternatively, it's possible that the cancellation will succeed, but data from the deployment is also committed.
URI
https://host/services/data/vXX.0/metadata/deployRequest/deployRequestId
Formats
JSON
HTTP Method
PATCH
Authentication
Authorization: Bearer token

Request Body: Request Deployment Cancellation

The JSON request body for a deployment cancellation includes a PATCH to the status of the original deployRequest.

Response Body: Request Deployment Cancellation

Because the cancellation request is processed asynchronously, the status shown in the response body can be either Canceling or Canceled.

When an HTTP status code of 202 (Accepted) is returned, your cancellation request is in progress or successful.