Skip to content

Commit 4925f04

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

8 files changed

Lines changed: 538 additions & 99 deletions

File tree

‎_data/vector_pro_endpoints/01.yaml‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,11 @@ endpoints:
2222
including owner details, cluster DNS endpoints, verified domains,
2323
site/environment counts grouped by status, deployment metrics, backup counts,
2424
and recent activity.
25+
26+
Site counts exclude sites in a terminal state (`terminated`, `termination_requested`,
27+
`canceled`). Environment counts exclude environments in a terminal state (`terminated`,
28+
`terminating`). Those statuses are therefore omitted from the `by_status` breakdowns
29+
and are not included in any of the total/convenience counts.
2530
authenticated: true
2631
deprecated: false
2732
headers:
@@ -57,36 +62,31 @@ endpoints:
5762
},
5863
"domains": ["example.com", "example.org"],
5964
"sites": {
60-
"total": 5,
65+
"total": 4,
6166
"by_status": {
6267
"pending": 0,
6368
"activation_requested": 0,
6469
"active": 3,
6570
"suspension_requested": 0,
6671
"suspended": 1,
67-
"unsuspension_requested": 0,
68-
"termination_requested": 0,
69-
"terminated": 1,
70-
"canceled": 0
72+
"unsuspension_requested": 0
7173
}
7274
},
7375
"environments": {
74-
"total": 8,
76+
"total": 7,
7577
"by_status": {
7678
"pending": 1,
7779
"provisioning": 0,
7880
"active": 5,
7981
"suspending": 0,
8082
"suspended": 1,
8183
"unsuspending": 0,
82-
"terminating": 0,
83-
"terminated": 1,
8484
"failed": 0
8585
}
8686
},
87-
"total_sites": 5,
87+
"total_sites": 4,
8888
"pending_sites": 0,
89-
"total_environments": 8,
89+
"total_environments": 7,
9090
"production_environments": 3,
9191
"deployments_30d": 12,
9292
"failed_deployments_30d": 1,

‎_data/vector_pro_endpoints/03.yaml‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -147,6 +147,7 @@ endpoints:
147147
"id": "01jfgxk4nqrst5vwx9yz0abcde",
148148
"your_customer_id": "cust_12345",
149149
"status": "active",
150+
"status_label": "Active",
150151
"dev_php_version": "8.3",
151152
"tags": ["wordpress", "production"],
152153
"dev_domain": "dev.wispy-dust.vectorpages.com",
@@ -164,6 +165,7 @@ endpoints:
164165
"name": "production",
165166
"is_production": true,
166167
"status": "active",
168+
"status_label": "Active",
167169
"php_version": "8.3",
168170
"platform_domain": "wispy-dust--prod.vectorpages.com",
169171
"custom_domain": "example.com",
@@ -278,6 +280,7 @@ endpoints:
278280
"id": "01jfgxk4nqrst5vwx9yz0abcde",
279281
"your_customer_id": "cust_12345",
280282
"status": "active",
283+
"status_label": "Active",
281284
"tags": ["wordpress", "production"],
282285
"dev_domain": "dev.wispy-dust.vectorpages.com",
283286
"dev_db_host": "dev-cluster.abc123.us-east-1.rds.amazonaws.com",
@@ -288,6 +291,7 @@ endpoints:
288291
"name": "production",
289292
"is_production": true,
290293
"status": "active",
294+
"status_label": "Active",
291295
"php_version": "8.3",
292296
"platform_domain": "wispy-dust--prod.vectorpages.com",
293297
"custom_domain": "example.com",
@@ -439,6 +443,7 @@ endpoints:
439443
"vector_environment_id": "01jfgxk4nqrst5vwx9yz0abcdg",
440444
"is_auto_deploy": false,
441445
"status": "deployed",
446+
"status_label": "Deployed",
442447
"stdout": "Deployment output...",
443448
"stderr": null,
444449
"build_output": null,
@@ -450,6 +455,7 @@ endpoints:
450455
"name": "production",
451456
"is_production": true,
452457
"status": "active",
458+
"status_label": "Active",
453459
"php_version": "8.3",
454460
"tags": ["wordpress"],
455461
"fqdn": "example.com",
@@ -598,6 +604,7 @@ endpoints:
598604
"id": "01jfgxk4nqrst5vwx9yz0abcde",
599605
"your_customer_id": "cust_67890",
600606
"status": "active",
607+
"status_label": "Active",
601608
"tags": ["wordpress", "staging"],
602609
"dev_domain": "dev.wispy-dust.vectorpages.com",
603610
"dev_db_host": "dev-cluster.abc123.us-east-1.rds.amazonaws.com",
@@ -706,6 +713,7 @@ endpoints:
706713
"id": "01jfgxk4nqrst5vwx9yz0abcde",
707714
"your_customer_id": "cust_12345",
708715
"status": "suspended",
716+
"status_label": "Suspended",
709717
"tags": [],
710718
"dev_domain": "dev.wispy-dust.vectorpages.com",
711719
"environments": [],
@@ -810,6 +818,7 @@ endpoints:
810818
"id": "01jfgxk4nqrst5vwx9yz0abcde",
811819
"your_customer_id": "cust_12345",
812820
"status": "active",
821+
"status_label": "Active",
813822
"tags": [],
814823
"dev_domain": "dev.wispy-dust.vectorpages.com",
815824
"environments": [],
@@ -1015,6 +1024,7 @@ endpoints:
10151024
"id": "01jfgxk4nqrst5vwx9yz0abcde",
10161025
"your_customer_id": "cust_12345",
10171026
"status": "pending",
1027+
"status_label": "Pending",
10181028
"dev_php_version": "8.3",
10191029
"tags": ["wordpress", "production"],
10201030
"dev_domain": "dev.wispy-dust.vectorpages.com",
@@ -1040,6 +1050,7 @@ endpoints:
10401050
"name": "production",
10411051
"is_production": true,
10421052
"status": "pending",
1053+
"status_label": "Pending",
10431054
"php_version": "8.3",
10441055
"platform_domain": "wispy-dust--prod.vectorpages.com",
10451056
"custom_domain": "example.com",
@@ -1052,6 +1063,7 @@ endpoints:
10521063
"name": "staging",
10531064
"is_production": false,
10541065
"status": "pending",
1066+
"status_label": "Pending",
10551067
"php_version": "8.3",
10561068
"platform_domain": "wispy-dust--staging.vectorpages.com",
10571069
"custom_domain": null,
@@ -1198,6 +1210,7 @@ endpoints:
11981210
"id": "01jfgxk4nqrst5vwx9yz0abcde",
11991211
"your_customer_id": "cust_12345",
12001212
"status": "terminating",
1213+
"status_label": "Terminating",
12011214
"tags": [],
12021215
"dev_domain": "dev.wispy-dust.vectorpages.com",
12031216
"dev_db_host": "dev-cluster.abc123.us-east-1.rds.amazonaws.com",
@@ -1351,6 +1364,7 @@ endpoints:
13511364
"id": "01jfgxk4nqrst5vwx9yz0abcdf",
13521365
"your_customer_id": "cust_12345",
13531366
"status": "pending",
1367+
"status_label": "Pending",
13541368
"tags": ["wordpress", "clone"],
13551369
"dev_domain": "dev.wispy-dust.vectorpages.com",
13561370
"dev_db_username": "db_01jfgxk4nqrst5vwx9yz0abcdf",
@@ -1475,6 +1489,7 @@ endpoints:
14751489
"id": "01jfgxk4nqrst5vwx9yz0abcde",
14761490
"your_customer_id": null,
14771491
"status": "active",
1492+
"status_label": "Active",
14781493
"dev_php_version": "8.3",
14791494
"tags": [],
14801495
"dev_domain": "dev.wispy-dust.vectorpages.com",
@@ -1574,6 +1589,7 @@ endpoints:
15741589
"id": "01jfgxk4nqrst5vwx9yz0abcde",
15751590
"your_customer_id": null,
15761591
"status": "active",
1592+
"status_label": "Active",
15771593
"dev_php_version": "8.3",
15781594
"tags": [],
15791595
"dev_domain": "dev.wispy-dust.vectorpages.com",
@@ -1664,6 +1680,7 @@ endpoints:
16641680
"id": "01jfgxk4nqrst5vwx9yz0abcde",
16651681
"your_customer_id": null,
16661682
"status": "active",
1683+
"status_label": "Active",
16671684
"dev_php_version": "8.3",
16681685
"tags": [],
16691686
"dev_domain": "wispy-dust.vectorpages.com",
@@ -1773,6 +1790,7 @@ endpoints:
17731790
"id": "01jfgxk4nqrst5vwx9yz0abcdg",
17741791
"vector_site_id": "01jfgxk4nqrst5vwx9yz0abcde",
17751792
"status": "pending",
1793+
"status_label": "Pending",
17761794
"format": "sql",
17771795
"size_bytes": null,
17781796
"duration_ms": null,
@@ -2002,6 +2020,7 @@ endpoints:
20022020
"id": "01jfgxk4nqrst5vwx9yz0abcdh",
20032021
"vector_site_id": "01jfgxk4nqrst5vwx9yz0abcde",
20042022
"status": "pending",
2023+
"status_label": "Pending",
20052024
"scope": null,
20062025
"filename": "backup.sql.gz",
20072026
"content_length": 52428800,
@@ -2040,6 +2059,7 @@ endpoints:
20402059
"id": "01jfgxk4nqrst5vwx9yz0abcdh",
20412060
"vector_site_id": "01jfgxk4nqrst5vwx9yz0abcde",
20422061
"status": "pending",
2062+
"status_label": "Pending",
20432063
"scope": null,
20442064
"filename": "backup.tar.gz",
20452065
"content_length": 161061273600,
@@ -2209,6 +2229,7 @@ endpoints:
22092229
"id": "01jfgxk4nqrst5vwx9yz0abcdh",
22102230
"vector_site_id": "01jfgxk4nqrst5vwx9yz0abcde",
22112231
"status": "uploaded",
2232+
"status_label": "Uploaded",
22122233
"scope": null,
22132234
"filename": "backup.sql.gz",
22142235
"content_length": 52428800,
@@ -2344,6 +2365,7 @@ endpoints:
23442365
"id": "01jfgxk4nqrst5vwx9yz0abcdh",
23452366
"vector_site_id": "01jfgxk4nqrst5vwx9yz0abcde",
23462367
"status": "pending",
2368+
"status_label": "Pending",
23472369
"scope": null,
23482370
"filename": "backup.sql.gz",
23492371
"content_length": 52428800,
@@ -2382,7 +2404,9 @@ endpoints:
23822404
"id": "01jfgxk4nqrst5vwx9yz0abcdh",
23832405
"vector_site_id": "01jfgxk4nqrst5vwx9yz0abcde",
23842406
"status": "completed",
2407+
"status_label": "Completed",
23852408
"scope": "full",
2409+
"scope_label": "Full",
23862410
"filename": "backup.sql.gz",
23872411
"content_length": 52428800,
23882412
"is_multipart": false,
@@ -2499,6 +2523,7 @@ endpoints:
24992523
"id": "01jfgxk4nqrst5vwx9yz0abcdg",
25002524
"vector_site_id": "01jfgxk4nqrst5vwx9yz0abcde",
25012525
"status": "completed",
2526+
"status_label": "Completed",
25022527
"format": "sql",
25032528
"size_bytes": 52428800,
25042529
"duration_ms": 30000,
@@ -2523,6 +2548,7 @@ endpoints:
25232548
"id": "01jfgxk4nqrst5vwx9yz0abcdg",
25242549
"vector_site_id": "01jfgxk4nqrst5vwx9yz0abcde",
25252550
"status": "processing",
2551+
"status_label": "Processing",
25262552
"format": "sql",
25272553
"size_bytes": null,
25282554
"duration_ms": null,

0 commit comments

Comments
 (0)