Skip to content

Commit 28d0b4c

Browse files
github-actions[bot]github-actions[bot]
committed
Update Vector Pro API documentation
1 parent 5d11f87 commit 28d0b4c

4 files changed

Lines changed: 671 additions & 18 deletions

File tree

‎_data/vector_pro_endpoints/03.yaml‎

Lines changed: 197 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -330,6 +330,183 @@ endpoints:
330330
controller: null
331331
method: null
332332
route: null
333+
-
334+
custom: []
335+
httpMethods:
336+
- GET
337+
uri: 'api/v1/vector/sites/{site}/deployments'
338+
metadata:
339+
custom: []
340+
groupName: Sites
341+
groupDescription: ''
342+
subgroup: |-
343+
Deployments
344+
345+
List deployments across all environments of a site.
346+
subgroupDescription: ''
347+
title: 'List Site Deployments'
348+
description: |-
349+
Retrieves a paginated list of deployments across all non-terminated
350+
environments belonging to the given site, ordered by most recent first.
351+
352+
Optionally filter by environment name to narrow results to a single
353+
environment (e.g. `production` or `staging`).
354+
355+
Deployments attached to terminated environments are always excluded,
356+
even when an explicit `environment` filter matches one.
357+
authenticated: true
358+
deprecated: false
359+
headers:
360+
Authorization: 'Bearer {YOUR_API_KEY}'
361+
Content-Type: application/json
362+
Accept: application/json
363+
urlParameters:
364+
site:
365+
custom: []
366+
name: site
367+
description: 'The site.'
368+
required: true
369+
example: architecto
370+
type: string
371+
enumValues: []
372+
exampleWasSpecified: false
373+
nullable: false
374+
deprecated: false
375+
vectorSite:
376+
custom: []
377+
name: vectorSite
378+
description: 'The site ID or subdomain.'
379+
required: true
380+
example: 01jfgxk4nqrst5vwx9yz0abcde
381+
type: string
382+
enumValues: []
383+
exampleWasSpecified: true
384+
nullable: false
385+
deprecated: false
386+
cleanUrlParameters:
387+
site: architecto
388+
vectorSite: 01jfgxk4nqrst5vwx9yz0abcde
389+
queryParameters:
390+
environment:
391+
custom: []
392+
name: environment
393+
description: 'Filter deployments to a specific environment by name.'
394+
required: false
395+
example: production
396+
type: string
397+
enumValues: []
398+
exampleWasSpecified: true
399+
nullable: false
400+
deprecated: false
401+
per_page:
402+
custom: []
403+
name: per_page
404+
description: 'Number of items per page (max 100). Default: 15.'
405+
required: false
406+
example: 25
407+
type: integer
408+
enumValues: []
409+
exampleWasSpecified: true
410+
nullable: false
411+
deprecated: false
412+
page:
413+
custom: []
414+
name: page
415+
description: 'Page number for pagination. Default: 1.'
416+
required: false
417+
example: 1
418+
type: integer
419+
enumValues: []
420+
exampleWasSpecified: true
421+
nullable: false
422+
deprecated: false
423+
cleanQueryParameters:
424+
environment: production
425+
per_page: 25
426+
page: 1
427+
bodyParameters: []
428+
cleanBodyParameters: []
429+
fileParameters: []
430+
responses:
431+
-
432+
custom: []
433+
status: 200
434+
content: |-
435+
{
436+
"data": [
437+
{
438+
"id": "01jfgxk4nqrst5vwx9yz0abcdh",
439+
"vector_environment_id": "01jfgxk4nqrst5vwx9yz0abcdg",
440+
"is_auto_deploy": false,
441+
"status": "deployed",
442+
"stdout": "Deployment output...",
443+
"stderr": null,
444+
"build_output": null,
445+
"actor": "user@example.com",
446+
"environment": {
447+
"id": "01jfgxk4nqrst5vwx9yz0abcdg",
448+
"vector_site_id": "01jfgxk4nqrst5vwx9yz0abcde",
449+
"your_customer_id": "cust_12345",
450+
"name": "production",
451+
"is_production": true,
452+
"status": "active",
453+
"php_version": "8.3",
454+
"tags": ["wordpress"],
455+
"fqdn": "example.com",
456+
"custom_domain": "example.com",
457+
"subdomain": "wispy-dust",
458+
"created_at": "2025-01-15T12:00:00+00:00",
459+
"updated_at": "2025-01-15T12:00:00+00:00"
460+
},
461+
"created_at": "2025-01-15T12:00:00+00:00",
462+
"updated_at": "2025-01-15T12:00:00+00:00"
463+
}
464+
],
465+
"links": {},
466+
"meta": {},
467+
"message": "Deployments retrieved successfully",
468+
"http_status": 200
469+
}
470+
headers: []
471+
description: Success
472+
-
473+
custom: []
474+
status: 401
475+
content: '{"data": {}, "message": "Unauthenticated", "http_status": 401}'
476+
headers: []
477+
description: Unauthenticated
478+
-
479+
custom: []
480+
status: 403
481+
content: '{"data": {}, "message": "Unauthorized", "http_status": 403}'
482+
headers: []
483+
description: Unauthorized
484+
-
485+
custom: []
486+
status: 404
487+
content: '{"data": {}, "message": "Site not found", "http_status": 404}'
488+
headers: []
489+
description: 'Site Not Found'
490+
-
491+
custom: []
492+
status: 422
493+
content: |-
494+
{
495+
"data": {},
496+
"errors": {"per_page": ["Maximum items per page is 100."]},
497+
"message": "Validation failed",
498+
"http_status": 422
499+
}
500+
headers: []
501+
description: 'Validation Error'
502+
responseFields: []
503+
auth:
504+
- headers
505+
- Authorization
506+
- 'Bearer 6g43cv8PD1aE5beadkZfhV6'
507+
controller: null
508+
method: null
509+
route: null
333510
-
334511
custom: []
335512
httpMethods:
@@ -967,8 +1144,10 @@ endpoints:
9671144
and CDN resources. The site status transitions to `terminating` and eventually
9681145
`terminated`.
9691146
970-
**Important:** All environments must be terminated before the site can be deleted.
971-
Use the environment delete endpoint to terminate each environment first.
1147+
**Important:** By default, all environments must be terminated before the site
1148+
can be deleted — use the environment delete endpoint to terminate each
1149+
environment first, or pass `delete_environments: true` to have any remaining
1150+
deployed environments terminated inline as part of the site deletion job.
9721151
9731152
This operation is irreversible. All site data and configurations will be
9741153
permanently removed.
@@ -994,8 +1173,20 @@ endpoints:
9941173
site: 01jfgxk4nqrst5vwx9yz0abcde
9951174
queryParameters: []
9961175
cleanQueryParameters: []
997-
bodyParameters: []
998-
cleanBodyParameters: []
1176+
bodyParameters:
1177+
delete_environments:
1178+
custom: []
1179+
name: delete_environments
1180+
description: 'Optional. When true, any remaining deployed environments are terminated as part of the site deletion job (each environment is terminated in sequence before the dev container and Ymir project are removed). When omitted or false, the request is rejected with 422 if deployed environments still exist.'
1181+
required: false
1182+
example: true
1183+
type: boolean
1184+
enumValues: []
1185+
exampleWasSpecified: true
1186+
nullable: false
1187+
deprecated: false
1188+
cleanBodyParameters:
1189+
delete_environments: true
9991190
fileParameters: []
10001191
responses:
10011192
-
@@ -1044,8 +1235,8 @@ endpoints:
10441235
content: |-
10451236
{
10461237
"data": {},
1047-
"errors": {"site": ["Cannot delete site that has active environments. Please terminate all environments first."]},
1048-
"message": "Validation failed",
1238+
"errors": {"site": ["Cannot delete site with deployed environments. Please terminate all deployed environments first, or pass delete_environments=true to terminate them as part of the site deletion."]},
1239+
"message": "Cannot delete site with deployed environments. Please terminate all deployed environments first, or pass delete_environments=true to terminate them as part of the site deletion.",
10491240
"http_status": 422
10501241
}
10511242
headers: []

‎_data/vector_pro_endpoints/04.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2422,15 +2422,15 @@ endpoints:
24222422
name: include_database
24232423
description: ''
24242424
required: false
2425-
example: true
2425+
example: false
24262426
type: boolean
24272427
enumValues: []
24282428
exampleWasSpecified: false
24292429
nullable: false
24302430
deprecated: false
24312431
cleanBodyParameters:
24322432
include_uploads: false
2433-
include_database: true
2433+
include_database: false
24342434
fileParameters: []
24352435
responses:
24362436
-

0 commit comments

Comments
 (0)