Skip to content

Commit 2fc66d7

Browse files
Update Vector Pro API documentation
1 parent 77d36bf commit 2fc66d7

4 files changed

Lines changed: 286 additions & 16 deletions

File tree

_data/vector_pro_endpoints/01.yaml

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,9 @@ endpoints:
1919
title: 'Get Account Summary'
2020
description: |-
2121
Retrieves a summary of the authenticated account's Vector Pro information
22-
including owner details, cluster DNS endpoints, verified domains, and
23-
site/environment counts grouped by status.
22+
including owner details, cluster DNS endpoints, verified domains,
23+
site/environment counts grouped by status, deployment metrics, backup counts,
24+
and recent activity.
2425
authenticated: true
2526
deprecated: false
2627
headers:
@@ -82,7 +83,16 @@ endpoints:
8283
"terminated": 1,
8384
"failed": 0
8485
}
85-
}
86+
},
87+
"total_sites": 5,
88+
"pending_sites": 0,
89+
"total_environments": 8,
90+
"production_environments": 3,
91+
"deployments_30d": 12,
92+
"failed_deployments_30d": 1,
93+
"active_backups": 4,
94+
"recent_activity": [],
95+
"recent_deployments": []
8696
},
8797
"message": "Account summary retrieved successfully",
8898
"http_status": 200

_data/vector_pro_endpoints/03.yaml

Lines changed: 76 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,11 @@ endpoints:
4646
description: |-
4747
Retrieves a paginated list of all sites for the authenticated account.
4848
Results include each site's environments and their associated domains.
49+
50+
Use `search` to filter by customer ID or subdomain, `status` to filter by
51+
site lifecycle state, and `sort`/`direction` to control ordering. The
52+
`last_deployed_at` field is computed from the most recent completed
53+
deployment across all environments and can also be used as a sort field.
4954
authenticated: true
5055
deprecated: false
5156
headers:
@@ -66,6 +71,50 @@ endpoints:
6671
exampleWasSpecified: true
6772
nullable: false
6873
deprecated: false
74+
search:
75+
custom: []
76+
name: search
77+
description: 'Search by `your_customer_id` or `subdomain` (partial, case-insensitive).'
78+
required: false
79+
example: acme
80+
type: string
81+
enumValues: []
82+
exampleWasSpecified: true
83+
nullable: true
84+
deprecated: false
85+
status:
86+
custom: []
87+
name: status
88+
description: 'Filter by site status. Must be one of: `pending`, `activation_requested`, `active`, `suspension_requested`, `suspended`, `unsuspension_requested`, `termination_requested`, `terminated`, `canceled`.'
89+
required: false
90+
example: active
91+
type: string
92+
enumValues: []
93+
exampleWasSpecified: true
94+
nullable: false
95+
deprecated: false
96+
sort:
97+
custom: []
98+
name: sort
99+
description: 'Sort results by the given field. Must be one of: `created_at`, `updated_at`, `status`, `your_customer_id`, `last_deployed_at`. Default: `created_at`.'
100+
required: false
101+
example: your_customer_id
102+
type: string
103+
enumValues: []
104+
exampleWasSpecified: true
105+
nullable: false
106+
deprecated: false
107+
direction:
108+
custom: []
109+
name: direction
110+
description: 'Sort direction. Must be `asc` or `desc`. Default: `desc`.'
111+
required: false
112+
example: asc
113+
type: string
114+
enumValues: []
115+
exampleWasSpecified: true
116+
nullable: false
117+
deprecated: false
69118
page:
70119
custom: []
71120
name: page
@@ -79,6 +128,10 @@ endpoints:
79128
deprecated: false
80129
cleanQueryParameters:
81130
per_page: 25
131+
search: acme
132+
status: active
133+
sort: your_customer_id
134+
direction: asc
82135
page: 1
83136
bodyParameters: []
84137
cleanBodyParameters: []
@@ -94,10 +147,17 @@ endpoints:
94147
"id": "01jfgxk4nqrst5vwx9yz0abcde",
95148
"your_customer_id": "cust_12345",
96149
"status": "active",
150+
"dev_php_version": "8.3",
97151
"tags": ["wordpress", "production"],
98152
"dev_domain": "dev.wispy-dust.vectorpages.com",
99153
"dev_db_host": "dev-cluster.abc123.us-east-1.rds.amazonaws.com",
100154
"dev_db_name": "db_01jfgxk4nqrst5vwx9yz0abcde",
155+
"dev_sftp": {
156+
"hostname": "ssh.vectorpages.com",
157+
"port": 22,
158+
"username": "wispy-dust"
159+
},
160+
"last_deployed_at": "2025-06-10T14:30:00+00:00",
101161
"environments": [
102162
{
103163
"id": "01jfgxk4nqrst5vwx9yz0abcdg",
@@ -135,6 +195,18 @@ endpoints:
135195
content: '{"data": {}, "message": "Unauthorized", "http_status": 403}'
136196
headers: []
137197
description: Unauthorized
198+
-
199+
custom: []
200+
status: 422
201+
content: |-
202+
{
203+
"data": {},
204+
"errors": {"status": ["The status must be a valid site status."]},
205+
"message": "Validation failed",
206+
"http_status": 422
207+
}
208+
headers: []
209+
description: 'Validation Error'
138210
responseFields: []
139211
auth:
140212
- headers
@@ -1577,10 +1649,10 @@ endpoints:
15771649
The maximum file size is 50GB by default. Higher limits can be configured
15781650
per-cluster on request.
15791651
1580-
For files larger than the multipart threshold (~5GB), returns multiple
1581-
presigned URLs (one per part) along with an `upload_id`. Parts are 5GB each
1582-
(the S3 maximum), so a 150GB file requires only 30 parts. For smaller files,
1583-
returns a single presigned upload URL.
1652+
For files larger than the multipart threshold (~100MB), returns multiple
1653+
presigned URLs (one per part) along with an `upload_id`. Parts are 100MB each,
1654+
so a 1GB file requires 10 parts. For smaller files, returns a single presigned
1655+
upload URL.
15841656
15851657
After uploading, call the "Run Import" endpoint to execute the import.
15861658
authenticated: true

0 commit comments

Comments
 (0)