You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
You will find relevant examples using `HTTP Request Syntax` in the sections below.
@@ -67,7 +70,7 @@ curl -s -X GET https://api.cloud.umbraco.com/v2/projects/$projectId/deployments
67
70
{% endtab %}
68
71
{% endtabs %}
69
72
70
-
## How to upload artifacts
73
+
## Deployment Artifacts
71
74
72
75
### Upload artifact
73
76
@@ -164,7 +167,7 @@ Response look like:
164
167
}
165
168
```
166
169
167
-
## How to make a deployment to Umbraco Cloud using the Umbraco CI/CD API
170
+
## Deployments
168
171
169
172
### Start the deployment
170
173
@@ -278,7 +281,7 @@ Should the deployment fail, check the `deploymentStatusMessages` for more inform
278
281
}
279
282
```
280
283
281
-
## Query Deployments and Get Diff
284
+
## Query Deployments and fetch Changes
282
285
283
286
### Get Deployments
284
287
@@ -341,7 +344,7 @@ The response from this API call will return an object containing a list of deplo
341
344
342
345
Sometimes updates are done directly on the Umbraco Cloud repository. We encourage you to not do any actual work there, but auto-upgrades and environment changes will affect the Umbraco Cloud git-repositories. To keep track of such changes, you can use the 'Get Deployment Diff' API. This API endpoint will provide you with a git-patch file detailing the changes between a specific deployment and the current state of the repository. To make this API call, you'll need to include both the `projectId` and the `deploymentId` of the deployment you want to check for differences against. This is a standard HTTP GET request.
343
346
344
-
Query parameter:
347
+
Required query parameter has been added to the endpoint:
345
348
-`TargetEnvironmentAlias`**REQUIRED** The intended deployment target environment for the diff.
The API response will vary based on whether or not there are changes to report. If no changes are detected, you'll receive an HTTP 204 No Content status. On the other hand, if there are changes, the API will return an HTTP 200 OK status along with a git-patch file as the content. This git-patch file can then be applied to your local repository to sync it with the changes.
364
367
368
+
{% hint style="info" %}
369
+
It is only possible to generate git-patch files when the selected `deploymentId` points to a deployment where the `targetEnvironmentAlias` then, is the same as in this request.
370
+
{% endhint %}
371
+
365
372
### Possible errors
366
373
367
374
When interacting with the Umbraco Cloud API, you may encounter various HTTP status codes that indicate the success or failure of your API request. Below is a table summarizing the possible status codes, their corresponding errors, and basic root causes to guide your troubleshooting:
0 commit comments