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
Copy file name to clipboardExpand all lines: umbraco-cloud/set-up/project-settings/umbraco-cicd/UmbracoCloudApi.md
+12-11Lines changed: 12 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,14 @@
1
1
# Cloud API For CI/CD Flow
2
2
3
-
The Umbraco Cloud API serves as a publicly accessible endpoint that customers can utilize to execute relevant tasks. 
3
+
The Umbraco Cloud API serves as a publicly accessible endpoint that customers can utilize to execute relevant tasks.
4
4
5
-
While its initial focus is on automating and managing deployments in Umbraco Cloud projects via the "Umbraco CI/CD Flow," future enhancements will broaden its capabilities to encompass a wider range of activities and options for Umbraco Cloud users. 
5
+
While its initial focus is on automating and managing deployments in Umbraco Cloud projects via the "Umbraco CI/CD Flow," future enhancements will broaden its capabilities to encompass a wider range of activities and options for Umbraco Cloud users.
6
6
7
-
For the scope of this discussion, we will concentrate solely on the endpoints associated with interactions within the Umbraco CI/CD Flow.
7
+
For the scope of this discussion, we will concentrate solely on the endpoints associated with interactions within the Umbraco CI/CD Flow.
8
8
9
9
## Getting started
10
10
11
-
To integrate Umbraco Cloud into your CI/CD pipeline, you'll need to make API calls to the following endpoint [`https://api.cloud.umbraco.com`](https://api.cloud.umbraco.com): 
11
+
To integrate Umbraco Cloud into your CI/CD pipeline, you'll need to make API calls to the following endpoint [`https://api.cloud.umbraco.com`](https://api.cloud.umbraco.com):
12
12
13
13
*`/$projectId/deployments`
14
14
*`/$projectId/deployments/$deploymentId`
@@ -19,7 +19,7 @@ You will find relevant examples using `Curl` and `Powershell` in the sections be
19
19
20
20
### How to enable CI/CD Integrator in the Umbraco Cloud Portal
21
21
22
-
To authenticate with the Umbraco Cloud API, you'll need your Project ID and API Key. These credentials can be found in your cloud project under the 'Settings' tab, and then navigating to the 'Advanced' page.
22
+
To authenticate with the Umbraco Cloud API, you'll need your Project ID and API Key. These credentials can be found under **Configuration > Advanced** in the Umbraco Cloud portal.
@@ -127,7 +127,7 @@ By adhering to these guidelines, you ensure that the uploaded content is an exac
127
127
128
128
The purpose of packaging your content into a ZIP file is to replace the existing content in the Umbraco Cloud repository upon unpackaging. This ensures that the repository is updated with the latest version of your project files.
129
129
130
-
Make sure your ZIP archive does not contain .git folder. If you're using the `.zipignore` file, you can add the following line `.git/*` to exclude it.
130
+
Make sure your ZIP archive does not contain .git folder. If you're using the `.zipignore` file, you can add the following line `.git/*` to exclude it.
131
131
132
132
#### A note about .gitignore
133
133
@@ -264,9 +264,10 @@ The response from this API call will return the same deployment object in JSON f
264
264
The endpoint lets you retrieve a list of completed deployments. It can only list deployments that has been run through the api.
265
265
266
266
The API allows you to filter and limit the number of returned deployments using query parameters:
267
-
-_Skip_ : optional, zero or positive integer
268
-
-_Take_ : optional, zero or positive integer
269
-
-_Includenulldeployments_ : optional, boolean, defaults to true
267
+
268
+
*_Skip_ : optional, zero or positive integer
269
+
*_Take_ : optional, zero or positive integer
270
+
*_Includenulldeployments_ : optional, boolean, defaults to true
270
271
271
272
The "skip" and "take" parameters, while optional, are always required to be used together.
272
273
@@ -284,8 +285,8 @@ response=$(curl -s -X GET $url \
The response from this API call will return an object containing a list of deployment objects. The deployment-objects are consistent with the structure used in other API responses.
288
-
Deployments are listed in descending order based on their creation timestamp.
288
+
289
+
The response from this API call will return an object containing a list of deployment objects. The deployment-objects are consistent with the structure used in other API responses. Deployments are listed in descending order based on their creation timestamp.
0 commit comments