Check the Status of Your Deployment Using REST Resources

Check the status of your deployment by using passing the deployment request ID in the URL The response body is similar to that returned by the original deployment request, but it includes information about the deployment in progress.

URI

https://host/services/data/vXX.0/metadata/deployRequest/DEPLOY_REQUEST_ID

To include more details in the response, use:

https://host/services/data/vXX.0/metadata/deployRequest/DEPLOY_REQUEST_ID?includeDetails=true

Formats

JSON

HTTP Method

GET

Authentication

Authorization: Bearer token

Response Body: Deploy Metadata

The following example shows the response when ?includeDetails=true is added as a query to the GET request.

1{
2	       "id" : "0Afxx00000000lWCAQ"
3	       "url" : "https://host/services/data/vXX.0/metadata/deployRequest/0Afxx00000000lWCAQ?includeDetails=true",
4        "deployResult" :
5            {
6            "checkOnly" : "false",
7            "ignoreWarnings" : "false",
8            "rollbackOnError" : "false",
9
10            "status : "InProgress",
11            "numberComponentsDeployed" : "10",
12            "numberComponentsTotal" : "1032",
13            "numberComponentErrors" : "0",
14            "numberTestsCompleted" : "45",
15            "numberTestsTotal" : "135",
16            "numberTestErrors" : "0",
17            "details" :  {
18	             "componentFailures" : [],
19             	"componentSuccesses" : [],
20                    "retrieveResult" : null,
21                    "runTestResults" : {
22                    "numRun" : 0,
23                    "successes" : [ … ],
24                    "failures" : []
25	         	         }
26            },
27
28            "createdDate" : "2017-10-10T08:22Z",
29            "startDate" : "2017-10-10T08:22Z",
30            "lastModifiedDate" : "2017-10-10T08:44Z",
31            "completedDate" : "2017-10-10T08:44Z",
32
33            "errorStatusCode" : null,
34            "errorMessage" : null,
35            "stateDetail" : "Processing Type: Apex Component",
36
37            "createdBy" : "005xx0000001Sv1m",
38            "createdByName" : "stephanie stevens",
39            "canceledBy" : null,
40            "canceledByName" : null,
41            "isRunTestsEnabled" : null
42            }
43
44       "deployOptions": {
45             "allowMissingFiles" : false,
46             "autoUpdatePackage" : false,
47             "checkOnly" : true,
48             "ignoreWarnings" : false,
49             "performRetrieve" : false,
50             "purgeOnDelete" : false,
51             "rollbackOnError" : false,
52             "runTests" : null,
53             "singlePackage" : true,
54             "testLevel" : "RunAllTestsInOrg"
55             }
56     }

Expect an HTTP status code of 200 (OK) to be returned.