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: swagger.yml
+53-4Lines changed: 53 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -158,6 +158,22 @@ paths:
158
158
post:
159
159
operationId: provisionSiteTLSCertificate
160
160
tags: [sniCertificate]
161
+
description: >-
162
+
Provisions or updates a TLS certificate for the site.
163
+
164
+
165
+
**Creating a certificate (site has no certificate):**
166
+
167
+
- Omit certificate params to initiate Let's Encrypt provisioning
168
+
169
+
- Provide certificate, key, and ca_certificates to upload a custom certificate
170
+
171
+
172
+
**Updating a certificate (site already has a certificate):**
173
+
174
+
- REQUIRES certificate, key, and ca_certificates to replace with a new custom certificate
175
+
176
+
- Use POST /api/v1/sites/{site_id}/ssl/renew to renew an existing Let's Encrypt certificate
161
177
parameters:
162
178
- name: site_id
163
179
type: string
@@ -166,17 +182,23 @@ paths:
166
182
- name: certificate
167
183
type: string
168
184
in: query
185
+
description: PEM-encoded certificate. Required when updating an existing certificate.
169
186
- name: key
170
187
type: string
171
188
in: query
189
+
description: PEM-encoded private key. Required when updating an existing certificate.
172
190
- name: ca_certificates
173
191
type: string
174
192
in: query
193
+
description: PEM-encoded CA certificate chain. Required when updating an existing certificate.
175
194
responses:
176
195
'200':
177
196
description: OK
178
197
schema:
179
198
$ref: '#/definitions/sniCertificate'
199
+
'422':
200
+
description: >-
201
+
Unprocessable Entity. Returns errors such as: "certificate parameter is required when updating an existing certificate" (when updating without params), "No custom domain configured", or "bad dns for custom domain"
180
202
default:
181
203
$ref: '#/responses/error'
182
204
get:
@@ -1208,17 +1230,44 @@ paths:
1208
1230
post:
1209
1231
operationId: createSiteBuild
1210
1232
tags: [build]
1233
+
description: 'Runs a build for a site. The build will be scheduled to run at the first opportunity, but it might not start immediately if insufficient account build capacity is available. Files for build could be also uploaded as a zipped site.'
1211
1234
parameters:
1212
-
- name: build
1213
-
in: body
1214
-
schema:
1215
-
$ref: '#/definitions/buildSetup'
1235
+
- name: branch
1236
+
description: The branch to build; defaults to main branch
1216
1237
required: false
1238
+
in: query
1239
+
type: string
1240
+
- name: clear_cache
1241
+
description: Whether to clear the build cache before building
1242
+
required: false
1243
+
in: query
1244
+
type: boolean
1245
+
- name: image
1246
+
description: The build image tag to use for the build
1247
+
required: false
1248
+
in: query
1249
+
type: string
1250
+
- name: template_id
1251
+
description: The build template to use for the build
0 commit comments