hostinger-api-mcp 2.0.0 → 2.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +423 -0
- package/README.md +406 -406
- package/gemini-extension.json +1 -1
- package/package.json +1 -1
- package/server.json +2 -2
- package/skills/headless/SKILL.md +1 -1
- package/skills/headless/references/DATABASE.md +14 -14
- package/skills/headless/references/DEPLOYMENT.md +5 -5
- package/skills/headless/references/SETUP.md +8 -8
- package/skills/headless/references/STORE.md +4 -4
- package/skills/headless/references/WORDPRESS.md +5 -5
- package/src/core/instructions.js +1 -1
- package/src/core/instructions.ts +1 -1
- package/src/core/runtime.js +9 -9
- package/src/core/runtime.ts +9 -9
- package/src/core/tools/agency-hosting.js +44 -44
- package/src/core/tools/agency-hosting.ts +44 -44
- package/src/core/tools/all.js +405 -405
- package/src/core/tools/all.ts +405 -405
- package/src/core/tools/billing.js +9 -9
- package/src/core/tools/billing.ts +9 -9
- package/src/core/tools/dns.js +8 -8
- package/src/core/tools/dns.ts +8 -8
- package/src/core/tools/domains.js +41 -41
- package/src/core/tools/domains.ts +41 -41
- package/src/core/tools/ecommerce.js +29 -29
- package/src/core/tools/ecommerce.ts +29 -29
- package/src/core/tools/horizons.js +6 -6
- package/src/core/tools/horizons.ts +6 -6
- package/src/core/tools/hosting.js +76 -76
- package/src/core/tools/hosting.ts +76 -76
- package/src/core/tools/mail.js +38 -38
- package/src/core/tools/mail.ts +38 -38
- package/src/core/tools/reach.js +52 -52
- package/src/core/tools/reach.ts +52 -52
- package/src/core/tools/vps.js +64 -64
- package/src/core/tools/vps.ts +64 -64
- package/src/core/tools/wordpress.js +38 -38
- package/src/core/tools/wordpress.ts +38 -38
- package/src/servers/agency-hosting.js +1 -1
- package/src/servers/agency-hosting.ts +1 -1
- package/src/servers/all.js +1 -1
- package/src/servers/all.ts +1 -1
- package/src/servers/billing.js +1 -1
- package/src/servers/billing.ts +1 -1
- package/src/servers/dns.js +1 -1
- package/src/servers/dns.ts +1 -1
- package/src/servers/domains.js +1 -1
- package/src/servers/domains.ts +1 -1
- package/src/servers/ecommerce.js +1 -1
- package/src/servers/ecommerce.ts +1 -1
- package/src/servers/horizons.js +1 -1
- package/src/servers/horizons.ts +1 -1
- package/src/servers/hosting.js +1 -1
- package/src/servers/hosting.ts +1 -1
- package/src/servers/mail.js +1 -1
- package/src/servers/mail.ts +1 -1
- package/src/servers/reach.js +1 -1
- package/src/servers/reach.ts +1 -1
- package/src/servers/vps.js +1 -1
- package/src/servers/vps.ts +1 -1
- package/src/servers/wordpress.js +1 -1
- package/src/servers/wordpress.ts +1 -1
- package/types.d.ts +405 -405
package/types.d.ts
CHANGED
|
@@ -5,9 +5,9 @@
|
|
|
5
5
|
|
|
6
6
|
export interface APITools {
|
|
7
7
|
/**
|
|
8
|
-
* Deploy a node-static Agency Plan (h5g) website from an archive file. WARNING: this overwrites the website's existing contents and cannot be undone — always confirm with the user before proceeding. Use this for Agency Plan websites of type node-static (a Node.js-built static site that requires a build step or a plain simple static site). The tool resolves the website from its domain, uploads the archive to the website's file browser over TUS, and triggers the build-assets process which builds the site and deploys the result to public_html. This operation is synchronous: the build and deployment complete before the tool returns, so the website is live as soon as the tool finishes successfully — there is no separate asynchronous build to wait for or poll. Upload credentials are generated and used internally — do not call a separate upload-url endpoint or upload the archive yourself, this tool does it end-to-end. For plain PHP applications that should be extracted as-is, use
|
|
8
|
+
* Deploy a node-static Agency Plan (h5g) website from an archive file. WARNING: this overwrites the website's existing contents and cannot be undone — always confirm with the user before proceeding. Use this for Agency Plan websites of type node-static (a Node.js-built static site that requires a build step or a plain simple static site). The tool resolves the website from its domain, uploads the archive to the website's file browser over TUS, and triggers the build-assets process which builds the site and deploys the result to public_html. This operation is synchronous: the build and deployment complete before the tool returns, so the website is live as soon as the tool finishes successfully — there is no separate asynchronous build to wait for or poll. Upload credentials are generated and used internally — do not call a separate upload-url endpoint or upload the archive yourself, this tool does it end-to-end. For plain PHP applications that should be extracted as-is, use agency-hosting_deploy-php-application instead. The website UID is automatically resolved from the domain.
|
|
9
9
|
*/
|
|
10
|
-
"agency-
|
|
10
|
+
"agency-hosting_deploy-node-static-website": {
|
|
11
11
|
params: {
|
|
12
12
|
/**
|
|
13
13
|
* Domain name of the Agency Plan website (e.g., example.com)
|
|
@@ -26,9 +26,9 @@ export interface APITools {
|
|
|
26
26
|
};
|
|
27
27
|
|
|
28
28
|
/**
|
|
29
|
-
* Deploy a PHP (or other non-build) Agency Plan (h5g) website from an archive file. WARNING: this overwrites the website's existing contents and cannot be undone — always confirm with the user before proceeding. Use this for Agency Plan websites where the archive contents should be extracted and served as-is with no build step (e.g., PHP applications). The tool resolves the website from its domain, uploads the archive to the website's file browser over TUS, and triggers the import-archive process which overwrites the website contents with the archive contents. This operation is synchronous: the archive is extracted and deployed before the tool returns, so the website is live as soon as the tool finishes successfully — there is no separate asynchronous build to wait for or poll. Upload credentials are generated and used internally — do not call a separate upload-url endpoint or upload the archive yourself, this tool does it end-to-end. For node-static websites that require a build step, use
|
|
29
|
+
* Deploy a PHP (or other non-build) Agency Plan (h5g) website from an archive file. WARNING: this overwrites the website's existing contents and cannot be undone — always confirm with the user before proceeding. Use this for Agency Plan websites where the archive contents should be extracted and served as-is with no build step (e.g., PHP applications). The tool resolves the website from its domain, uploads the archive to the website's file browser over TUS, and triggers the import-archive process which overwrites the website contents with the archive contents. This operation is synchronous: the archive is extracted and deployed before the tool returns, so the website is live as soon as the tool finishes successfully — there is no separate asynchronous build to wait for or poll. Upload credentials are generated and used internally — do not call a separate upload-url endpoint or upload the archive yourself, this tool does it end-to-end. For node-static websites that require a build step, use agency-hosting_deploy-node-static-website instead. The website UID is automatically resolved from the domain.
|
|
30
30
|
*/
|
|
31
|
-
"agency-
|
|
31
|
+
"agency-hosting_deploy-php-application": {
|
|
32
32
|
params: {
|
|
33
33
|
/**
|
|
34
34
|
* Domain name of the Agency Plan website (e.g., example.com)
|
|
@@ -49,7 +49,7 @@ export interface APITools {
|
|
|
49
49
|
/**
|
|
50
50
|
* Import a WordPress website from an archive file to a hosting server. This tool uploads a website archive (zip, tar, tar.gz, etc.) and a database dump (.sql file) to deploy a complete WordPress website. The archive will be extracted on the server automatically. Note: This process may take a while for larger sites. After upload completion, files are being extracted and the site will be available in a few minutes. Upload credentials are generated and used internally — do not call a separate upload-url endpoint or upload the files yourself, this tool does it end-to-end. The username will be automatically resolved from the domain.
|
|
51
51
|
*/
|
|
52
|
-
"
|
|
52
|
+
"hosting_import-wordpress-website": {
|
|
53
53
|
params: {
|
|
54
54
|
/**
|
|
55
55
|
* Domain name associated with the hosting account (e.g., example.com)
|
|
@@ -70,7 +70,7 @@ export interface APITools {
|
|
|
70
70
|
/**
|
|
71
71
|
* Deploy a WordPress plugin from a directory to a hosting server. This tool uploads all plugin files and triggers plugin deployment. Upload credentials are generated and used internally — do not call a separate upload-url endpoint or upload the files yourself, this tool does it end-to-end.
|
|
72
72
|
*/
|
|
73
|
-
"
|
|
73
|
+
"hosting_deploy-wordpress-plugin": {
|
|
74
74
|
params: {
|
|
75
75
|
/**
|
|
76
76
|
* Domain name associated with the hosting account (e.g., example.com)
|
|
@@ -91,7 +91,7 @@ export interface APITools {
|
|
|
91
91
|
/**
|
|
92
92
|
* Deploy a WordPress theme from a directory to a hosting server. This tool uploads all theme files and triggers theme deployment. The uploaded theme can optionally be activated after deployment. Upload credentials are generated and used internally — do not call a separate upload-url endpoint or upload the files yourself, this tool does it end-to-end.
|
|
93
93
|
*/
|
|
94
|
-
"
|
|
94
|
+
"hosting_deploy-wordpress-theme": {
|
|
95
95
|
params: {
|
|
96
96
|
/**
|
|
97
97
|
* Domain name associated with the hosting account (e.g., example.com)
|
|
@@ -114,9 +114,9 @@ export interface APITools {
|
|
|
114
114
|
};
|
|
115
115
|
|
|
116
116
|
/**
|
|
117
|
-
* Deploy a JavaScript application from an archive file to a hosting server. IMPORTANT: the archive must ONLY contain application source files, not the build output, skip node_modules directory; also exclude all files matched by .gitignore if the ignore file exists. The build process will be triggered automatically on the server after the archive is uploaded. Upload credentials are generated and used internally — do not call a separate upload-url endpoint or upload the archive yourself, this tool does it end-to-end. After deployment, use the
|
|
117
|
+
* Deploy a JavaScript application from an archive file to a hosting server. IMPORTANT: the archive must ONLY contain application source files, not the build output, skip node_modules directory; also exclude all files matched by .gitignore if the ignore file exists. The build process will be triggered automatically on the server after the archive is uploaded. Upload credentials are generated and used internally — do not call a separate upload-url endpoint or upload the archive yourself, this tool does it end-to-end. After deployment, use the hosting_list-js-deployments tool to check deployment status and track build progress.
|
|
118
118
|
*/
|
|
119
|
-
"
|
|
119
|
+
"hosting_deploy-js-application": {
|
|
120
120
|
params: {
|
|
121
121
|
/**
|
|
122
122
|
* Domain name associated with the hosting account (e.g., example.com)
|
|
@@ -135,9 +135,9 @@ export interface APITools {
|
|
|
135
135
|
};
|
|
136
136
|
|
|
137
137
|
/**
|
|
138
|
-
* Deploy a static website from an archive file to a hosting server. IMPORTANT: This tool only works for static websites with no build process. The archive must contain pre-built static files (HTML, CSS, JavaScript, images, etc.) ready to be served. If the website has a package.json file or requires a build command, use
|
|
138
|
+
* Deploy a static website from an archive file to a hosting server. IMPORTANT: This tool only works for static websites with no build process. The archive must contain pre-built static files (HTML, CSS, JavaScript, images, etc.) ready to be served. If the website has a package.json file or requires a build command, use hosting_deploy-js-application instead. The tool uploads the archive to the website's file browser over TUS and triggers deployment; the archive is extracted and deployed directly without any build steps. Upload credentials are generated and used internally — do not call a separate upload-url endpoint or upload the archive yourself, this tool does it end-to-end. The username will be automatically resolved from the domain.
|
|
139
139
|
*/
|
|
140
|
-
"
|
|
140
|
+
"hosting_deploy-static-website": {
|
|
141
141
|
params: {
|
|
142
142
|
/**
|
|
143
143
|
* Domain name associated with the hosting account (e.g., example.com)
|
|
@@ -158,7 +158,7 @@ export interface APITools {
|
|
|
158
158
|
/**
|
|
159
159
|
* List javascript application deployments for checking their status. Use this tool when customer asks for the status of the deployment. This tool retrieves a paginated list of Node.js application deployments for a domain with optional filtering by deployment states.
|
|
160
160
|
*/
|
|
161
|
-
"
|
|
161
|
+
"hosting_list-js-deployments": {
|
|
162
162
|
params: {
|
|
163
163
|
/**
|
|
164
164
|
* Domain name associated with the hosting account (e.g., example.com)
|
|
@@ -183,7 +183,7 @@ export interface APITools {
|
|
|
183
183
|
/**
|
|
184
184
|
* Retrieve logs for a specified JavaScript application deployment for debugging purposes in case of failure.
|
|
185
185
|
*/
|
|
186
|
-
"
|
|
186
|
+
"hosting_show-js-deployment-logs": {
|
|
187
187
|
params: {
|
|
188
188
|
/**
|
|
189
189
|
* Domain name associated with the hosting account (e.g., example.com)
|
|
@@ -209,7 +209,7 @@ Each datacenter includes a `pinger_url` you can ping from the client to measure
|
|
|
209
209
|
latency; comparing the results across datacenters lets you pick the nearest one (lowest
|
|
210
210
|
ping) before choosing its `code` as the `datacenter_code` when creating a website setup.
|
|
211
211
|
*/
|
|
212
|
-
"agency-
|
|
212
|
+
"agency-hosting_datacenters_list": {
|
|
213
213
|
params: {
|
|
214
214
|
/**
|
|
215
215
|
* Agency Plan order ID
|
|
@@ -225,7 +225,7 @@ ping) before choosing its `code` as the `datacenter_code` when creating a websit
|
|
|
225
225
|
Provide the current domain in the path and the new domain in the request body.
|
|
226
226
|
Set domain to null to revert to the temporary domain.
|
|
227
227
|
*/
|
|
228
|
-
"agency-
|
|
228
|
+
"agency-hosting_domains_change-website": {
|
|
229
229
|
params: {
|
|
230
230
|
/**
|
|
231
231
|
* Agency Plan website UID
|
|
@@ -246,7 +246,7 @@ Set domain to null to revert to the temporary domain.
|
|
|
246
246
|
/**
|
|
247
247
|
* Links a domain to the specified Agency Plan website so it can serve traffic for that domain.
|
|
248
248
|
*/
|
|
249
|
-
"agency-
|
|
249
|
+
"agency-hosting_domains_link-to-website": {
|
|
250
250
|
params: {
|
|
251
251
|
/**
|
|
252
252
|
* Agency Plan website UID
|
|
@@ -265,7 +265,7 @@ Set domain to null to revert to the temporary domain.
|
|
|
265
265
|
|
|
266
266
|
Use the website_uuids filter to narrow results to specific websites.
|
|
267
267
|
*/
|
|
268
|
-
"agency-
|
|
268
|
+
"agency-hosting_domains_list": {
|
|
269
269
|
params: {
|
|
270
270
|
/**
|
|
271
271
|
* Page number
|
|
@@ -292,7 +292,7 @@ Website files and database are preserved, and any other linked domains remain ac
|
|
|
292
292
|
|
|
293
293
|
If this is the only domain on the website, unlinking leaves the website without an accessible domain.
|
|
294
294
|
*/
|
|
295
|
-
"agency-
|
|
295
|
+
"agency-hosting_domains_unlink-from-website": {
|
|
296
296
|
params: {
|
|
297
297
|
/**
|
|
298
298
|
* Agency Plan website UID
|
|
@@ -345,7 +345,7 @@ curl -i -X PATCH "{url}/${FILE}?override=true" \
|
|
|
345
345
|
# -> 204 No Content, Upload-Offset response header equals SIZE when done
|
|
346
346
|
```
|
|
347
347
|
*/
|
|
348
|
-
"agency-
|
|
348
|
+
"agency-hosting_files_generate-upload-url": {
|
|
349
349
|
params: {
|
|
350
350
|
/**
|
|
351
351
|
* Agency Plan website UID
|
|
@@ -362,7 +362,7 @@ Upload the archive to the website's root directory via file browser first, then
|
|
|
362
362
|
filename in this request. Website contents are overwritten by the archive contents. Supported
|
|
363
363
|
archive types: .zip, .tar, .tar.gz, .tgz.
|
|
364
364
|
*/
|
|
365
|
-
"agency-
|
|
365
|
+
"agency-hosting_files_import-website-from-archive": {
|
|
366
366
|
params: {
|
|
367
367
|
/**
|
|
368
368
|
* Agency Plan website UID
|
|
@@ -382,7 +382,7 @@ selected time frame, plus the plan quotas. Figures cover the whole order
|
|
|
382
382
|
account. Values may be up to one hour stale. CPU, memory, and process usage
|
|
383
383
|
are on the resource-usage-metrics endpoint.
|
|
384
384
|
*/
|
|
385
|
-
"agency-
|
|
385
|
+
"agency-hosting_metrics_list-plan-order-disk-usage": {
|
|
386
386
|
params: {
|
|
387
387
|
/**
|
|
388
388
|
* Agency Plan order ID
|
|
@@ -399,7 +399,7 @@ are on the resource-usage-metrics endpoint.
|
|
|
399
399
|
/**
|
|
400
400
|
* Returns a paginated list of Agency Plan orders accessible to the authenticated client.
|
|
401
401
|
*/
|
|
402
|
-
"agency-
|
|
402
|
+
"agency-hosting_orders_list": {
|
|
403
403
|
params: {
|
|
404
404
|
/**
|
|
405
405
|
* Page number
|
|
@@ -421,7 +421,7 @@ are excluded from both the order totals and the per-website breakdown.
|
|
|
421
421
|
Values may be up to one hour stale. Disk and inode usage are on the
|
|
422
422
|
disk-usage-metrics endpoint.
|
|
423
423
|
*/
|
|
424
|
-
"agency-
|
|
424
|
+
"agency-hosting_metrics_list-order-resource-usage": {
|
|
425
425
|
params: {
|
|
426
426
|
/**
|
|
427
427
|
* Agency Plan order ID
|
|
@@ -438,7 +438,7 @@ disk-usage-metrics endpoint.
|
|
|
438
438
|
/**
|
|
439
439
|
* Lists every PHP extension available to an Agency Plan website and whether it is currently enabled.
|
|
440
440
|
*/
|
|
441
|
-
"agency-
|
|
441
|
+
"agency-hosting_php_list-extensions-for-website": {
|
|
442
442
|
params: {
|
|
443
443
|
/**
|
|
444
444
|
* Agency Plan website UID
|
|
@@ -451,7 +451,7 @@ disk-usage-metrics endpoint.
|
|
|
451
451
|
/**
|
|
452
452
|
* Replaces the set of PHP extensions enabled on an Agency Plan website with the ones provided. Any toggleable extension not in the request is disabled, so call the extensions endpoint first and send the full desired set. Extensions compiled into PHP, reported with the "built-in" state, are always active and are unaffected.
|
|
453
453
|
*/
|
|
454
|
-
"agency-
|
|
454
|
+
"agency-hosting_php_replace-website-extensions": {
|
|
455
455
|
params: {
|
|
456
456
|
/**
|
|
457
457
|
* Agency Plan website UID
|
|
@@ -468,7 +468,7 @@ disk-usage-metrics endpoint.
|
|
|
468
468
|
/**
|
|
469
469
|
* Lists the php.ini directives that can be configured for an Agency Plan website, each with its default, the value currently in effect, and the values it accepts.
|
|
470
470
|
*/
|
|
471
|
-
"agency-
|
|
471
|
+
"agency-hosting_php_list-options-for-website": {
|
|
472
472
|
params: {
|
|
473
473
|
/**
|
|
474
474
|
* Agency Plan website UID
|
|
@@ -481,7 +481,7 @@ disk-usage-metrics endpoint.
|
|
|
481
481
|
/**
|
|
482
482
|
* Replaces the custom php.ini values on an Agency Plan website with the ones provided. Any option not in the request is reset to its default, so call the options endpoint first and send the full desired set. Sending an empty array resets every option to its default.
|
|
483
483
|
*/
|
|
484
|
-
"agency-
|
|
484
|
+
"agency-hosting_php_replace-website-options": {
|
|
485
485
|
params: {
|
|
486
486
|
/**
|
|
487
487
|
* Agency Plan website UID
|
|
@@ -498,7 +498,7 @@ disk-usage-metrics endpoint.
|
|
|
498
498
|
/**
|
|
499
499
|
* Lists the PHP versions available to websites created under an Agency Plan order, determined by the server the order is hosted on. Use this before creating a website; for a website that already exists, call the website-scoped versions endpoint instead.
|
|
500
500
|
*/
|
|
501
|
-
"agency-
|
|
501
|
+
"agency-hosting_php_list-versions-for-order": {
|
|
502
502
|
params: {
|
|
503
503
|
/**
|
|
504
504
|
* Agency Plan order ID
|
|
@@ -511,7 +511,7 @@ disk-usage-metrics endpoint.
|
|
|
511
511
|
/**
|
|
512
512
|
* Lists the PHP versions an Agency Plan website can be switched to. The version the website is currently running is returned as settings.php.version by the website details endpoint.
|
|
513
513
|
*/
|
|
514
|
-
"agency-
|
|
514
|
+
"agency-hosting_php_list-versions-for-website": {
|
|
515
515
|
params: {
|
|
516
516
|
/**
|
|
517
517
|
* Agency Plan website UID
|
|
@@ -524,7 +524,7 @@ disk-usage-metrics endpoint.
|
|
|
524
524
|
/**
|
|
525
525
|
* Switches an Agency Plan website to a different PHP version. Call the available versions endpoint first to see which versions can be selected. The website restarts on the new version, so requests served during the switch may fail and code that is incompatible with the target version will break.
|
|
526
526
|
*/
|
|
527
|
-
"agency-
|
|
527
|
+
"agency-hosting_php_update-website-version": {
|
|
528
528
|
params: {
|
|
529
529
|
/**
|
|
530
530
|
* Agency Plan website UID
|
|
@@ -557,7 +557,7 @@ Common setups:
|
|
|
557
557
|
Provisioning runs in the background, so the response returns immediately with a setup UUID
|
|
558
558
|
that identifies the job. The new website becomes reachable once provisioning finishes.
|
|
559
559
|
*/
|
|
560
|
-
"agency-
|
|
560
|
+
"agency-hosting_website-setups_create": {
|
|
561
561
|
params: {
|
|
562
562
|
/**
|
|
563
563
|
* Agency Plan order ID
|
|
@@ -598,7 +598,7 @@ endpoint.
|
|
|
598
598
|
Poll this endpoint using the `setup_uuid` returned from the provisioning request until
|
|
599
599
|
`status` becomes `completed`, at which point `website_uid` identifies the new website.
|
|
600
600
|
*/
|
|
601
|
-
"agency-
|
|
601
|
+
"agency-hosting_website-setups_status": {
|
|
602
602
|
params: {
|
|
603
603
|
/**
|
|
604
604
|
* Agency Plan order ID
|
|
@@ -622,7 +622,7 @@ failed setup counts until it is cleaned up), or when the domain hit its limit of
|
|
|
622
622
|
per seven days. Returns 429 when the same domain was requested less than a minute ago, and 403
|
|
623
623
|
when the website is suspended or locked, and 404 when the website or the domain does not exist.
|
|
624
624
|
*/
|
|
625
|
-
"agency-
|
|
625
|
+
"agency-hosting_ssl_reinstall-website": {
|
|
626
626
|
params: {
|
|
627
627
|
/**
|
|
628
628
|
* Agency Plan website UID
|
|
@@ -647,7 +647,7 @@ or when the domain hit its limit of three setups per seven days. Returns 429 whe
|
|
|
647
647
|
domain was requested less than a minute ago, 403 when the website is suspended or locked, and
|
|
648
648
|
404 when the website or the domain does not exist.
|
|
649
649
|
*/
|
|
650
|
-
"agency-
|
|
650
|
+
"agency-hosting_ssl_install-website": {
|
|
651
651
|
params: {
|
|
652
652
|
/**
|
|
653
653
|
* Agency Plan website UID
|
|
@@ -672,7 +672,7 @@ the domain. `failed` means the last setup gave up and no valid certificate is in
|
|
|
672
672
|
`expired` means the certificate has run out. `not_installed` means the domain has no
|
|
673
673
|
certificate and no setup process. Returns 404 when the website or the domain does not exist.
|
|
674
674
|
*/
|
|
675
|
-
"agency-
|
|
675
|
+
"agency-hosting_ssl_website-status": {
|
|
676
676
|
params: {
|
|
677
677
|
/**
|
|
678
678
|
* Agency Plan website UID
|
|
@@ -696,7 +696,7 @@ Returns 422 when a certificate process is recorded for the domain (a failed setu
|
|
|
696
696
|
it is cleaned up), 429 when the same domain was requested less than a minute ago, and 403 when
|
|
697
697
|
the website is suspended or locked, and 404 when the website or the domain does not exist.
|
|
698
698
|
*/
|
|
699
|
-
"agency-
|
|
699
|
+
"agency-hosting_ssl_uninstall-website": {
|
|
700
700
|
params: {
|
|
701
701
|
/**
|
|
702
702
|
* Agency Plan website UID
|
|
@@ -716,7 +716,7 @@ the website is suspended or locked, and 404 when the website or the domain does
|
|
|
716
716
|
Upload the archive to file browser first, then provide its relative path from document root in this request.
|
|
717
717
|
Website contents are overwritten by the build result, which is deployed to public_html.
|
|
718
718
|
*/
|
|
719
|
-
"agency-
|
|
719
|
+
"agency-hosting_websites_build-nodejs-assets": {
|
|
720
720
|
params: {
|
|
721
721
|
/**
|
|
722
722
|
* Agency Plan website UID
|
|
@@ -735,7 +735,7 @@ Website contents are overwritten by the build result, which is deployed to publi
|
|
|
735
735
|
|
|
736
736
|
This operation clears all cache types for the website.
|
|
737
737
|
*/
|
|
738
|
-
"agency-
|
|
738
|
+
"agency-hosting_cache_clear-website": {
|
|
739
739
|
params: {
|
|
740
740
|
/**
|
|
741
741
|
* Agency Plan website UID
|
|
@@ -750,7 +750,7 @@ This operation clears all cache types for the website.
|
|
|
750
750
|
|
|
751
751
|
Each entry includes the schedule expression and the command executed on that schedule.
|
|
752
752
|
*/
|
|
753
|
-
"agency-
|
|
753
|
+
"agency-hosting_cron-jobs_list-website": {
|
|
754
754
|
params: {
|
|
755
755
|
/**
|
|
756
756
|
* Agency Plan website UID
|
|
@@ -773,7 +773,7 @@ Each entry includes the schedule expression and the command executed on that sch
|
|
|
773
773
|
|
|
774
774
|
Returns the created cron job, including its uuid, which is required to delete the cron job.
|
|
775
775
|
*/
|
|
776
|
-
"agency-
|
|
776
|
+
"agency-hosting_cron-jobs_create-website": {
|
|
777
777
|
params: {
|
|
778
778
|
/**
|
|
779
779
|
* Agency Plan website UID
|
|
@@ -796,7 +796,7 @@ Returns the created cron job, including its uuid, which is required to delete th
|
|
|
796
796
|
|
|
797
797
|
The operation is idempotent: deleting a cron job that does not exist succeeds without error.
|
|
798
798
|
*/
|
|
799
|
-
"agency-
|
|
799
|
+
"agency-hosting_cron-jobs_delete-website": {
|
|
800
800
|
params: {
|
|
801
801
|
/**
|
|
802
802
|
* Agency Plan website UID
|
|
@@ -815,7 +815,7 @@ The operation is idempotent: deleting a cron job that does not exist succeeds wi
|
|
|
815
815
|
|
|
816
816
|
Each entry includes the database's non-system users.
|
|
817
817
|
*/
|
|
818
|
-
"agency-
|
|
818
|
+
"agency-hosting_databases_list-website": {
|
|
819
819
|
params: {
|
|
820
820
|
/**
|
|
821
821
|
* Agency Plan website UID
|
|
@@ -838,7 +838,7 @@ Each entry includes the database's non-system users.
|
|
|
838
838
|
|
|
839
839
|
The database name, username, and password must all be provided by the caller.
|
|
840
840
|
*/
|
|
841
|
-
"agency-
|
|
841
|
+
"agency-hosting_databases_create-website": {
|
|
842
842
|
params: {
|
|
843
843
|
/**
|
|
844
844
|
* Agency Plan website UID
|
|
@@ -865,7 +865,7 @@ The database name, username, and password must all be provided by the caller.
|
|
|
865
865
|
|
|
866
866
|
The operation is idempotent: deleting a database that does not exist succeeds without error.
|
|
867
867
|
*/
|
|
868
|
-
"agency-
|
|
868
|
+
"agency-hosting_databases_delete-website": {
|
|
869
869
|
params: {
|
|
870
870
|
/**
|
|
871
871
|
* Agency Plan website UID
|
|
@@ -884,7 +884,7 @@ The operation is idempotent: deleting a database that does not exist succeeds wi
|
|
|
884
884
|
|
|
885
885
|
Each database supports a single non-system user; creating a user for a database that already has one fails.
|
|
886
886
|
*/
|
|
887
|
-
"agency-
|
|
887
|
+
"agency-hosting_databases_create-website-user": {
|
|
888
888
|
params: {
|
|
889
889
|
/**
|
|
890
890
|
* Agency Plan website UID
|
|
@@ -915,7 +915,7 @@ Each database supports a single non-system user; creating a user for a database
|
|
|
915
915
|
|
|
916
916
|
The operation is idempotent: deleting a user that does not exist succeeds without error.
|
|
917
917
|
*/
|
|
918
|
-
"agency-
|
|
918
|
+
"agency-hosting_databases_delete-website-user": {
|
|
919
919
|
params: {
|
|
920
920
|
/**
|
|
921
921
|
* Agency Plan website UID
|
|
@@ -937,7 +937,7 @@ The operation is idempotent: deleting a user that does not exist succeeds withou
|
|
|
937
937
|
* Retrieves detailed information about a specific Agency Plan website, including configuration,
|
|
938
938
|
status, metadata, hosting plan details, and resource quotas.
|
|
939
939
|
*/
|
|
940
|
-
"agency-
|
|
940
|
+
"agency-hosting_websites_get": {
|
|
941
941
|
params: {
|
|
942
942
|
/**
|
|
943
943
|
* Agency Plan website UID
|
|
@@ -952,7 +952,7 @@ status, metadata, hosting plan details, and resource quotas.
|
|
|
952
952
|
website is immediately transitioned to a deleting state and the underlying server
|
|
953
953
|
resources are removed in the background.
|
|
954
954
|
*/
|
|
955
|
-
"agency-
|
|
955
|
+
"agency-hosting_websites_delete": {
|
|
956
956
|
params: {
|
|
957
957
|
/**
|
|
958
958
|
* Agency Plan website UID
|
|
@@ -977,7 +977,7 @@ WordPress websites (`website_types=wordpress`) or only Node.js websites
|
|
|
977
977
|
(`website_types=nodejs`). Combine with `order_ids`, `states`, or `domain` for more
|
|
978
978
|
targeted results.
|
|
979
979
|
*/
|
|
980
|
-
"agency-
|
|
980
|
+
"agency-hosting_websites_list-plan": {
|
|
981
981
|
params: {
|
|
982
982
|
/**
|
|
983
983
|
* Page number
|
|
@@ -1013,7 +1013,7 @@ targeted results.
|
|
|
1013
1013
|
Each process has a unique ID (for tracking), a type, and a status (running, completed, failed).
|
|
1014
1014
|
Poll this endpoint after initiating async operations (SSL setup, backups, cloning) to track progress.
|
|
1015
1015
|
*/
|
|
1016
|
-
"agency-
|
|
1016
|
+
"agency-hosting_websites_list-processes": {
|
|
1017
1017
|
params: {
|
|
1018
1018
|
/**
|
|
1019
1019
|
* Agency Plan website UID
|
|
@@ -1026,7 +1026,7 @@ Poll this endpoint after initiating async operations (SSL setup, backups, clonin
|
|
|
1026
1026
|
/**
|
|
1027
1027
|
* Changes the installed WordPress core version on an Agency Plan website to one of the versions available for installation.
|
|
1028
1028
|
*/
|
|
1029
|
-
"agency-
|
|
1029
|
+
"agency-hosting_wordpress_change-version": {
|
|
1030
1030
|
params: {
|
|
1031
1031
|
/**
|
|
1032
1032
|
* Agency Plan website UID
|
|
@@ -1044,7 +1044,7 @@ Poll this endpoint after initiating async operations (SSL setup, backups, clonin
|
|
|
1044
1044
|
* Returns the current WordPress settings for an Agency Plan website: installed core version,
|
|
1045
1045
|
LiteSpeed Cache plugin status, object cache status, and maintenance mode status.
|
|
1046
1046
|
*/
|
|
1047
|
-
"agency-
|
|
1047
|
+
"agency-hosting_wordpress_settings": {
|
|
1048
1048
|
params: {
|
|
1049
1049
|
/**
|
|
1050
1050
|
* Agency Plan website UID
|
|
@@ -1057,7 +1057,7 @@ LiteSpeed Cache plugin status, object cache status, and maintenance mode status.
|
|
|
1057
1057
|
/**
|
|
1058
1058
|
* Lists the WordPress core versions available for installation on an Agency Plan website.
|
|
1059
1059
|
*/
|
|
1060
|
-
"agency-
|
|
1060
|
+
"agency-hosting_wordpress_list-versions": {
|
|
1061
1061
|
params: {
|
|
1062
1062
|
/**
|
|
1063
1063
|
* Agency Plan website UID
|
|
@@ -1075,7 +1075,7 @@ e.g: float `17.99` is displayed as integer `1799`.
|
|
|
1075
1075
|
|
|
1076
1076
|
Use this endpoint to view available services and pricing before placing orders.
|
|
1077
1077
|
*/
|
|
1078
|
-
"
|
|
1078
|
+
"billing_catalog_list": {
|
|
1079
1079
|
params: {
|
|
1080
1080
|
/**
|
|
1081
1081
|
* Filter catalog items by category
|
|
@@ -1109,7 +1109,7 @@ order completes, use the relevant product endpoints or
|
|
|
1109
1109
|
|
|
1110
1110
|
Use this endpoint to purchase any product available in the catalog.
|
|
1111
1111
|
*/
|
|
1112
|
-
"
|
|
1112
|
+
"billing_orders_create-purchase": {
|
|
1113
1113
|
params: {
|
|
1114
1114
|
/**
|
|
1115
1115
|
* Payment method ID, default will be used if not provided
|
|
@@ -1132,7 +1132,7 @@ Use this endpoint to purchase any product available in the catalog.
|
|
|
1132
1132
|
|
|
1133
1133
|
Use this endpoint to configure the primary payment method for future orders.
|
|
1134
1134
|
*/
|
|
1135
|
-
"
|
|
1135
|
+
"billing_payment-methods_set-default": {
|
|
1136
1136
|
params: {
|
|
1137
1137
|
/**
|
|
1138
1138
|
* Payment method ID
|
|
@@ -1147,7 +1147,7 @@ Use this endpoint to configure the primary payment method for future orders.
|
|
|
1147
1147
|
|
|
1148
1148
|
Use this endpoint to remove unused payment methods from user accounts.
|
|
1149
1149
|
*/
|
|
1150
|
-
"
|
|
1150
|
+
"billing_payment-methods_delete": {
|
|
1151
1151
|
params: {
|
|
1152
1152
|
/**
|
|
1153
1153
|
* Payment method ID
|
|
@@ -1165,7 +1165,7 @@ please use [hPanel](https://hpanel.hostinger.com/billing/payment-methods).
|
|
|
1165
1165
|
|
|
1166
1166
|
Use this endpoint to view available payment options before creating orders.
|
|
1167
1167
|
*/
|
|
1168
|
-
"
|
|
1168
|
+
"billing_payment-methods_list": {
|
|
1169
1169
|
params: {
|
|
1170
1170
|
|
|
1171
1171
|
};
|
|
@@ -1177,7 +1177,7 @@ Use this endpoint to view available payment options before creating orders.
|
|
|
1177
1177
|
|
|
1178
1178
|
Use this endpoint to monitor active services and billing status.
|
|
1179
1179
|
*/
|
|
1180
|
-
"
|
|
1180
|
+
"billing_subscriptions_list": {
|
|
1181
1181
|
params: {
|
|
1182
1182
|
|
|
1183
1183
|
};
|
|
@@ -1189,7 +1189,7 @@ Use this endpoint to monitor active services and billing status.
|
|
|
1189
1189
|
|
|
1190
1190
|
Use this endpoint when disable auto-renewal for a subscription.
|
|
1191
1191
|
*/
|
|
1192
|
-
"
|
|
1192
|
+
"billing_subscriptions_disable-auto-renewal": {
|
|
1193
1193
|
params: {
|
|
1194
1194
|
/**
|
|
1195
1195
|
* Subscription ID
|
|
@@ -1204,7 +1204,7 @@ Use this endpoint when disable auto-renewal for a subscription.
|
|
|
1204
1204
|
|
|
1205
1205
|
Use this endpoint when enable auto-renewal for a subscription.
|
|
1206
1206
|
*/
|
|
1207
|
-
"
|
|
1207
|
+
"billing_subscriptions_enable-auto-renewal": {
|
|
1208
1208
|
params: {
|
|
1209
1209
|
/**
|
|
1210
1210
|
* Subscription ID
|
|
@@ -1229,7 +1229,7 @@ complete asynchronously once the payment is confirmed.
|
|
|
1229
1229
|
|
|
1230
1230
|
Use this endpoint to renew any subscription available in your account.
|
|
1231
1231
|
*/
|
|
1232
|
-
"
|
|
1232
|
+
"billing_subscriptions_renew": {
|
|
1233
1233
|
params: {
|
|
1234
1234
|
/**
|
|
1235
1235
|
* Subscription ID
|
|
@@ -1252,7 +1252,7 @@ Use this endpoint to renew any subscription available in your account.
|
|
|
1252
1252
|
|
|
1253
1253
|
Use this endpoint to view historical DNS configurations for domains.
|
|
1254
1254
|
*/
|
|
1255
|
-
"
|
|
1255
|
+
"dns_snapshots_get": {
|
|
1256
1256
|
params: {
|
|
1257
1257
|
/**
|
|
1258
1258
|
* Domain name
|
|
@@ -1271,7 +1271,7 @@ Use this endpoint to view historical DNS configurations for domains.
|
|
|
1271
1271
|
|
|
1272
1272
|
Use this endpoint to view available DNS backup points for restoration.
|
|
1273
1273
|
*/
|
|
1274
|
-
"
|
|
1274
|
+
"dns_snapshots_list": {
|
|
1275
1275
|
params: {
|
|
1276
1276
|
/**
|
|
1277
1277
|
* Domain name
|
|
@@ -1286,7 +1286,7 @@ Use this endpoint to view available DNS backup points for restoration.
|
|
|
1286
1286
|
|
|
1287
1287
|
Use this endpoint to revert domain DNS to a previous configuration.
|
|
1288
1288
|
*/
|
|
1289
|
-
"
|
|
1289
|
+
"dns_snapshots_restore": {
|
|
1290
1290
|
params: {
|
|
1291
1291
|
/**
|
|
1292
1292
|
* Domain name
|
|
@@ -1305,7 +1305,7 @@ Use this endpoint to revert domain DNS to a previous configuration.
|
|
|
1305
1305
|
|
|
1306
1306
|
Use this endpoint to view current DNS configuration for domain management.
|
|
1307
1307
|
*/
|
|
1308
|
-
"
|
|
1308
|
+
"dns_records_list": {
|
|
1309
1309
|
params: {
|
|
1310
1310
|
/**
|
|
1311
1311
|
* Domain name
|
|
@@ -1323,7 +1323,7 @@ Otherwise existing records will be updated and new records will be added.
|
|
|
1323
1323
|
|
|
1324
1324
|
Use this endpoint to modify domain DNS configuration.
|
|
1325
1325
|
*/
|
|
1326
|
-
"
|
|
1326
|
+
"dns_records_update": {
|
|
1327
1327
|
params: {
|
|
1328
1328
|
/**
|
|
1329
1329
|
* Domain name
|
|
@@ -1354,7 +1354,7 @@ refer to the `Update zone records` endpoint.
|
|
|
1354
1354
|
|
|
1355
1355
|
Use this endpoint to remove specific DNS records from domains.
|
|
1356
1356
|
*/
|
|
1357
|
-
"
|
|
1357
|
+
"dns_records_delete": {
|
|
1358
1358
|
params: {
|
|
1359
1359
|
/**
|
|
1360
1360
|
* Domain name
|
|
@@ -1369,7 +1369,7 @@ Use this endpoint to remove specific DNS records from domains.
|
|
|
1369
1369
|
|
|
1370
1370
|
Use this endpoint to restore domain DNS to original configuration.
|
|
1371
1371
|
*/
|
|
1372
|
-
"
|
|
1372
|
+
"dns_records_reset": {
|
|
1373
1373
|
params: {
|
|
1374
1374
|
/**
|
|
1375
1375
|
* Domain name
|
|
@@ -1399,7 +1399,7 @@ If there is validation error, the response will fail with `422 Validation error`
|
|
|
1399
1399
|
|
|
1400
1400
|
Use this endpoint to verify DNS record validity before applying changes.
|
|
1401
1401
|
*/
|
|
1402
|
-
"
|
|
1402
|
+
"dns_records_validate": {
|
|
1403
1403
|
params: {
|
|
1404
1404
|
/**
|
|
1405
1405
|
* Domain name
|
|
@@ -1422,7 +1422,7 @@ If no matching RRs are found, they are created.
|
|
|
1422
1422
|
/**
|
|
1423
1423
|
* Retrieve a list of pending and completed domain verifications.
|
|
1424
1424
|
*/
|
|
1425
|
-
"
|
|
1425
|
+
"domains_verifications_direct": {
|
|
1426
1426
|
params: {
|
|
1427
1427
|
|
|
1428
1428
|
};
|
|
@@ -1438,7 +1438,7 @@ Endpoint has rate limit of 90 requests per minute.
|
|
|
1438
1438
|
|
|
1439
1439
|
Use this endpoint to find a domain name when you only know what the website is about.
|
|
1440
1440
|
*/
|
|
1441
|
-
"
|
|
1441
|
+
"domains_availability_suggest-names-from-description": {
|
|
1442
1442
|
params: {
|
|
1443
1443
|
/**
|
|
1444
1444
|
* Free-text description of the project the domain is needed for
|
|
@@ -1461,7 +1461,7 @@ Endpoint has rate limit of 90 requests per minute.
|
|
|
1461
1461
|
|
|
1462
1462
|
Use this endpoint when the domain you wanted is taken and you need close alternatives.
|
|
1463
1463
|
*/
|
|
1464
|
-
"
|
|
1464
|
+
"domains_availability_suggest-names-from": {
|
|
1465
1465
|
params: {
|
|
1466
1466
|
/**
|
|
1467
1467
|
* Domain name to base the suggestions on
|
|
@@ -1486,7 +1486,7 @@ Endpoint has rate limit of 90 requests per minute.
|
|
|
1486
1486
|
|
|
1487
1487
|
Use this endpoint to verify domain availability before purchase.
|
|
1488
1488
|
*/
|
|
1489
|
-
"
|
|
1489
|
+
"domains_availability_check": {
|
|
1490
1490
|
params: {
|
|
1491
1491
|
/**
|
|
1492
1492
|
* Domain name (without TLD)
|
|
@@ -1509,7 +1509,7 @@ Use this endpoint to verify domain availability before purchase.
|
|
|
1509
1509
|
|
|
1510
1510
|
Use this endpoint to view current redirect configuration for domains.
|
|
1511
1511
|
*/
|
|
1512
|
-
"
|
|
1512
|
+
"domains_forwarding_get": {
|
|
1513
1513
|
params: {
|
|
1514
1514
|
/**
|
|
1515
1515
|
* Domain name
|
|
@@ -1524,7 +1524,7 @@ Use this endpoint to view current redirect configuration for domains.
|
|
|
1524
1524
|
|
|
1525
1525
|
Use this endpoint to modify existing redirect configuration for domains.
|
|
1526
1526
|
*/
|
|
1527
|
-
"
|
|
1527
|
+
"domains_forwarding_update": {
|
|
1528
1528
|
params: {
|
|
1529
1529
|
/**
|
|
1530
1530
|
* Domain name
|
|
@@ -1547,7 +1547,7 @@ Use this endpoint to modify existing redirect configuration for domains.
|
|
|
1547
1547
|
|
|
1548
1548
|
Use this endpoint to remove redirect configuration from domains.
|
|
1549
1549
|
*/
|
|
1550
|
-
"
|
|
1550
|
+
"domains_forwarding_delete": {
|
|
1551
1551
|
params: {
|
|
1552
1552
|
/**
|
|
1553
1553
|
* Domain name
|
|
@@ -1562,7 +1562,7 @@ Use this endpoint to remove redirect configuration from domains.
|
|
|
1562
1562
|
|
|
1563
1563
|
Use this endpoint to set up domain redirects to other URLs.
|
|
1564
1564
|
*/
|
|
1565
|
-
"
|
|
1565
|
+
"domains_forwarding_create": {
|
|
1566
1566
|
params: {
|
|
1567
1567
|
/**
|
|
1568
1568
|
* Domain name
|
|
@@ -1587,7 +1587,7 @@ Both the old and new registrant must confirm it before the WHOIS change takes ef
|
|
|
1587
1587
|
|
|
1588
1588
|
Use this endpoint to check the status of a WHOIS change awaiting registrant confirmation.
|
|
1589
1589
|
*/
|
|
1590
|
-
"
|
|
1590
|
+
"domains_whois_pending-irtp-verification": {
|
|
1591
1591
|
params: {
|
|
1592
1592
|
/**
|
|
1593
1593
|
* Domain name
|
|
@@ -1603,7 +1603,7 @@ Use this endpoint to check the status of a WHOIS change awaiting registrant conf
|
|
|
1603
1603
|
Use this endpoint to back out of a WHOIS change that is stuck waiting on registrant confirmation,
|
|
1604
1604
|
for example when the confirmation email cannot be received, without waiting out the 5-day expiry.
|
|
1605
1605
|
*/
|
|
1606
|
-
"
|
|
1606
|
+
"domains_whois_cancel-pending-irtp-verification": {
|
|
1607
1607
|
params: {
|
|
1608
1608
|
/**
|
|
1609
1609
|
* Domain name
|
|
@@ -1620,7 +1620,7 @@ Returns 404 when no account is moving this domain to you.
|
|
|
1620
1620
|
|
|
1621
1621
|
Use this endpoint to check whether a domain addressed to you is still waiting to be accepted.
|
|
1622
1622
|
*/
|
|
1623
|
-
"
|
|
1623
|
+
"domains_move_incoming": {
|
|
1624
1624
|
params: {
|
|
1625
1625
|
/**
|
|
1626
1626
|
* Domain name
|
|
@@ -1651,7 +1651,7 @@ Until then the move stays in the `activating` status, which can be followed with
|
|
|
1651
1651
|
|
|
1652
1652
|
Use this endpoint to take ownership of a domain offered to you.
|
|
1653
1653
|
*/
|
|
1654
|
-
"
|
|
1654
|
+
"domains_move_accept-incoming": {
|
|
1655
1655
|
params: {
|
|
1656
1656
|
/**
|
|
1657
1657
|
* Domain name
|
|
@@ -1673,7 +1673,7 @@ Moves you have already accepted cannot be rejected anymore.
|
|
|
1673
1673
|
|
|
1674
1674
|
Use this endpoint to decline a domain you do not want to take over.
|
|
1675
1675
|
*/
|
|
1676
|
-
"
|
|
1676
|
+
"domains_move_reject-incoming": {
|
|
1677
1677
|
params: {
|
|
1678
1678
|
/**
|
|
1679
1679
|
* Domain name
|
|
@@ -1690,7 +1690,7 @@ Moves of every status are returned, including the ones which already completed.
|
|
|
1690
1690
|
|
|
1691
1691
|
Use this endpoint to find domains waiting for you to accept them.
|
|
1692
1692
|
*/
|
|
1693
|
-
"
|
|
1693
|
+
"domains_move_incoming-list": {
|
|
1694
1694
|
params: {
|
|
1695
1695
|
|
|
1696
1696
|
};
|
|
@@ -1704,7 +1704,7 @@ Returns 404 when the domain has no move in progress.
|
|
|
1704
1704
|
|
|
1705
1705
|
Use this endpoint to track the status of a move you have initiated for a single domain.
|
|
1706
1706
|
*/
|
|
1707
|
-
"
|
|
1707
|
+
"domains_move_outgoing": {
|
|
1708
1708
|
params: {
|
|
1709
1709
|
/**
|
|
1710
1710
|
* Domain name
|
|
@@ -1728,7 +1728,7 @@ such requests are rejected with a 428 status code.
|
|
|
1728
1728
|
|
|
1729
1729
|
Use this endpoint to hand a domain over to another Hostinger user.
|
|
1730
1730
|
*/
|
|
1731
|
-
"
|
|
1731
|
+
"domains_move_start-outgoing": {
|
|
1732
1732
|
params: {
|
|
1733
1733
|
/**
|
|
1734
1734
|
* Domain name
|
|
@@ -1750,7 +1750,7 @@ The domain stays in your account.
|
|
|
1750
1750
|
|
|
1751
1751
|
Use this endpoint to withdraw a move you no longer want to complete.
|
|
1752
1752
|
*/
|
|
1753
|
-
"
|
|
1753
|
+
"domains_move_cancel-outgoing": {
|
|
1754
1754
|
params: {
|
|
1755
1755
|
/**
|
|
1756
1756
|
* Domain name
|
|
@@ -1767,7 +1767,7 @@ Only moves which have not completed yet are returned.
|
|
|
1767
1767
|
|
|
1768
1768
|
Use this endpoint to track moves you have initiated and the accounts they are addressed to.
|
|
1769
1769
|
*/
|
|
1770
|
-
"
|
|
1770
|
+
"domains_move_outgoing-list": {
|
|
1771
1771
|
params: {
|
|
1772
1772
|
|
|
1773
1773
|
};
|
|
@@ -1782,7 +1782,7 @@ Requesting a new code invalidates any code retrieved previously.
|
|
|
1782
1782
|
|
|
1783
1783
|
Use this endpoint to obtain the code required to transfer a domain to another registrar.
|
|
1784
1784
|
*/
|
|
1785
|
-
"
|
|
1785
|
+
"domains_portfolio_authorization-code": {
|
|
1786
1786
|
params: {
|
|
1787
1787
|
/**
|
|
1788
1788
|
* Domain name
|
|
@@ -1811,7 +1811,7 @@ for example `2037` when no free domain is available.
|
|
|
1811
1811
|
|
|
1812
1812
|
Use this endpoint to register a domain using a free domain from your account.
|
|
1813
1813
|
*/
|
|
1814
|
-
"
|
|
1814
|
+
"domains_portfolio_claim-free": {
|
|
1815
1815
|
params: {
|
|
1816
1816
|
/**
|
|
1817
1817
|
* Domain name
|
|
@@ -1837,7 +1837,7 @@ the domain cannot be transferred to another registrar without first disabling th
|
|
|
1837
1837
|
|
|
1838
1838
|
Use this endpoint to secure domains against unauthorized transfers.
|
|
1839
1839
|
*/
|
|
1840
|
-
"
|
|
1840
|
+
"domains_portfolio_enable-lock": {
|
|
1841
1841
|
params: {
|
|
1842
1842
|
/**
|
|
1843
1843
|
* Domain name
|
|
@@ -1854,7 +1854,7 @@ Domain lock needs to be disabled before transferring the domain to another regis
|
|
|
1854
1854
|
|
|
1855
1855
|
Use this endpoint to prepare domains for transfer to other registrars.
|
|
1856
1856
|
*/
|
|
1857
|
-
"
|
|
1857
|
+
"domains_portfolio_disable-lock": {
|
|
1858
1858
|
params: {
|
|
1859
1859
|
/**
|
|
1860
1860
|
* Domain name
|
|
@@ -1869,7 +1869,7 @@ Use this endpoint to prepare domains for transfer to other registrars.
|
|
|
1869
1869
|
|
|
1870
1870
|
Use this endpoint to view comprehensive domain configuration and status.
|
|
1871
1871
|
*/
|
|
1872
|
-
"
|
|
1872
|
+
"domains_portfolio_get": {
|
|
1873
1873
|
params: {
|
|
1874
1874
|
/**
|
|
1875
1875
|
* Domain name
|
|
@@ -1884,7 +1884,7 @@ Use this endpoint to view comprehensive domain configuration and status.
|
|
|
1884
1884
|
|
|
1885
1885
|
Use this endpoint to view user's domain portfolio.
|
|
1886
1886
|
*/
|
|
1887
|
-
"
|
|
1887
|
+
"domains_portfolio_list": {
|
|
1888
1888
|
params: {
|
|
1889
1889
|
|
|
1890
1890
|
};
|
|
@@ -1909,7 +1909,7 @@ Some TLDs require `additional_details` to be provided and these will be validate
|
|
|
1909
1909
|
|
|
1910
1910
|
Use this endpoint to register new domains for users.
|
|
1911
1911
|
*/
|
|
1912
|
-
"
|
|
1912
|
+
"domains_portfolio_purchase": {
|
|
1913
1913
|
params: {
|
|
1914
1914
|
/**
|
|
1915
1915
|
* Domain name
|
|
@@ -1946,7 +1946,7 @@ When privacy protection is enabled, domain owner's personal information is hidde
|
|
|
1946
1946
|
|
|
1947
1947
|
Use this endpoint to protect domain owner's personal information from public view.
|
|
1948
1948
|
*/
|
|
1949
|
-
"
|
|
1949
|
+
"domains_portfolio_enable-privacy-protection": {
|
|
1950
1950
|
params: {
|
|
1951
1951
|
/**
|
|
1952
1952
|
* Domain name
|
|
@@ -1963,7 +1963,7 @@ When privacy protection is disabled, domain owner's personal information is visi
|
|
|
1963
1963
|
|
|
1964
1964
|
Use this endpoint to make domain owner's information publicly visible.
|
|
1965
1965
|
*/
|
|
1966
|
-
"
|
|
1966
|
+
"domains_portfolio_disable-privacy-protection": {
|
|
1967
1967
|
params: {
|
|
1968
1968
|
/**
|
|
1969
1969
|
* Domain name
|
|
@@ -1979,7 +1979,7 @@ expiration date.
|
|
|
1979
1979
|
|
|
1980
1980
|
Use this endpoint to build renewal automation and expiry monitoring for a single domain.
|
|
1981
1981
|
*/
|
|
1982
|
-
"
|
|
1982
|
+
"domains_portfolio_renewal-information": {
|
|
1983
1983
|
params: {
|
|
1984
1984
|
/**
|
|
1985
1985
|
* Domain name
|
|
@@ -2018,7 +2018,7 @@ only once it is registered.
|
|
|
2018
2018
|
|
|
2019
2019
|
Use this endpoint to finish registering a domain that is awaiting setup on your account.
|
|
2020
2020
|
*/
|
|
2021
|
-
"
|
|
2021
|
+
"domains_portfolio_complete-setup": {
|
|
2022
2022
|
params: {
|
|
2023
2023
|
/**
|
|
2024
2024
|
* Domain name
|
|
@@ -2043,7 +2043,7 @@ Be aware, that improper nameserver configuration can lead to the domain being un
|
|
|
2043
2043
|
|
|
2044
2044
|
Use this endpoint to configure custom DNS hosting for domains.
|
|
2045
2045
|
*/
|
|
2046
|
-
"
|
|
2046
|
+
"domains_portfolio_update-nameservers": {
|
|
2047
2047
|
params: {
|
|
2048
2048
|
/**
|
|
2049
2049
|
* Domain name
|
|
@@ -2089,7 +2089,7 @@ Requests which cannot be fulfilled are rejected with an error code in the respon
|
|
|
2089
2089
|
|
|
2090
2090
|
Use this endpoint to transfer a domain using a free domain transfer from your account.
|
|
2091
2091
|
*/
|
|
2092
|
-
"
|
|
2092
|
+
"domains_transfer_claim-free": {
|
|
2093
2093
|
params: {
|
|
2094
2094
|
/**
|
|
2095
2095
|
* Domain name
|
|
@@ -2116,7 +2116,7 @@ Use this endpoint to transfer a domain using a free domain transfer from your ac
|
|
|
2116
2116
|
|
|
2117
2117
|
Use this endpoint to track an incoming or outgoing registrar transfer and its status.
|
|
2118
2118
|
*/
|
|
2119
|
-
"
|
|
2119
|
+
"domains_transfer_get": {
|
|
2120
2120
|
params: {
|
|
2121
2121
|
/**
|
|
2122
2122
|
* Domain name
|
|
@@ -2131,7 +2131,7 @@ Use this endpoint to track an incoming or outgoing registrar transfer and its st
|
|
|
2131
2131
|
|
|
2132
2132
|
Use this endpoint to monitor incoming and outgoing registrar transfers across your domains.
|
|
2133
2133
|
*/
|
|
2134
|
-
"
|
|
2134
|
+
"domains_transfer_list": {
|
|
2135
2135
|
params: {
|
|
2136
2136
|
|
|
2137
2137
|
};
|
|
@@ -2151,7 +2151,7 @@ The change is processed asynchronously.
|
|
|
2151
2151
|
|
|
2152
2152
|
Use this endpoint to move a registered domain onto different contact information.
|
|
2153
2153
|
*/
|
|
2154
|
-
"
|
|
2154
|
+
"domains_whois_change-for": {
|
|
2155
2155
|
params: {
|
|
2156
2156
|
/**
|
|
2157
2157
|
* WHOIS profile ID to assign to the domain
|
|
@@ -2176,7 +2176,7 @@ The default profile is pre-selected for the TLD it belongs to when registering n
|
|
|
2176
2176
|
|
|
2177
2177
|
Use this endpoint to avoid picking contact information for every registration.
|
|
2178
2178
|
*/
|
|
2179
|
-
"
|
|
2179
|
+
"domains_whois_set-as-default": {
|
|
2180
2180
|
params: {
|
|
2181
2181
|
/**
|
|
2182
2182
|
* WHOIS ID
|
|
@@ -2193,7 +2193,7 @@ The profile itself is kept, it is only no longer pre-selected for its TLD.
|
|
|
2193
2193
|
|
|
2194
2194
|
Use this endpoint to stop reusing contact information for new registrations.
|
|
2195
2195
|
*/
|
|
2196
|
-
"
|
|
2196
|
+
"domains_whois_unset-default": {
|
|
2197
2197
|
params: {
|
|
2198
2198
|
/**
|
|
2199
2199
|
* WHOIS ID
|
|
@@ -2208,7 +2208,7 @@ Use this endpoint to stop reusing contact information for new registrations.
|
|
|
2208
2208
|
|
|
2209
2209
|
Use this endpoint to view domain registration contact information.
|
|
2210
2210
|
*/
|
|
2211
|
-
"
|
|
2211
|
+
"domains_whois_get": {
|
|
2212
2212
|
params: {
|
|
2213
2213
|
/**
|
|
2214
2214
|
* WHOIS ID
|
|
@@ -2223,7 +2223,7 @@ Use this endpoint to view domain registration contact information.
|
|
|
2223
2223
|
|
|
2224
2224
|
Use this endpoint to remove unused contact profiles from account.
|
|
2225
2225
|
*/
|
|
2226
|
-
"
|
|
2226
|
+
"domains_whois_delete": {
|
|
2227
2227
|
params: {
|
|
2228
2228
|
/**
|
|
2229
2229
|
* WHOIS ID
|
|
@@ -2238,7 +2238,7 @@ Use this endpoint to remove unused contact profiles from account.
|
|
|
2238
2238
|
|
|
2239
2239
|
Use this endpoint to view available contact profiles for domain registration.
|
|
2240
2240
|
*/
|
|
2241
|
-
"
|
|
2241
|
+
"domains_whois_list": {
|
|
2242
2242
|
params: {
|
|
2243
2243
|
/**
|
|
2244
2244
|
* Filter by TLD (without leading dot)
|
|
@@ -2253,7 +2253,7 @@ Use this endpoint to view available contact profiles for domain registration.
|
|
|
2253
2253
|
|
|
2254
2254
|
Use this endpoint to add new contact information for domain registration.
|
|
2255
2255
|
*/
|
|
2256
|
-
"
|
|
2256
|
+
"domains_whois_create": {
|
|
2257
2257
|
params: {
|
|
2258
2258
|
/**
|
|
2259
2259
|
* TLD of the domain (without leading dot)
|
|
@@ -2284,7 +2284,7 @@ Use this endpoint to add new contact information for domain registration.
|
|
|
2284
2284
|
|
|
2285
2285
|
Use this endpoint to view which domains use specific contact profiles.
|
|
2286
2286
|
*/
|
|
2287
|
-
"
|
|
2287
|
+
"domains_whois_usage": {
|
|
2288
2288
|
params: {
|
|
2289
2289
|
/**
|
|
2290
2290
|
* WHOIS ID
|
|
@@ -2299,7 +2299,7 @@ Use this endpoint to view which domains use specific contact profiles.
|
|
|
2299
2299
|
Amounts for fixed discounts are integers in the smallest currency unit; percentage
|
|
2300
2300
|
discounts carry a whole-number value between 1 and 100.
|
|
2301
2301
|
*/
|
|
2302
|
-
"
|
|
2302
|
+
"ecommerce_discounts_list": {
|
|
2303
2303
|
params: {
|
|
2304
2304
|
/**
|
|
2305
2305
|
* The ID of the store to list discounts for.
|
|
@@ -2326,7 +2326,7 @@ discounts carry a whole-number value between 1 and 100.
|
|
|
2326
2326
|
unit (e.g. $10 is 1000); percentage discounts take a whole-number value between 1 and 100.
|
|
2327
2327
|
Free-shipping discounts ignore value. Returns the created discount.
|
|
2328
2328
|
*/
|
|
2329
|
-
"
|
|
2329
|
+
"ecommerce_discounts_create": {
|
|
2330
2330
|
params: {
|
|
2331
2331
|
/**
|
|
2332
2332
|
* The ID of the store to create the discount for.
|
|
@@ -2381,7 +2381,7 @@ Free-shipping discounts ignore value. Returns the created discount.
|
|
|
2381
2381
|
channel to your store and keeping your catalog, orders, shipping and payments in sync through
|
|
2382
2382
|
the Ecommerce API.
|
|
2383
2383
|
*/
|
|
2384
|
-
"
|
|
2384
|
+
"ecommerce_miscellaneous_custom-storefront-setup-instructions": {
|
|
2385
2385
|
params: {
|
|
2386
2386
|
|
|
2387
2387
|
};
|
|
@@ -2391,7 +2391,7 @@ the Ecommerce API.
|
|
|
2391
2391
|
/**
|
|
2392
2392
|
* Cancel the order and optionally email the customer. Returns the updated order summary.
|
|
2393
2393
|
*/
|
|
2394
|
-
"
|
|
2394
|
+
"ecommerce_orders_cancel": {
|
|
2395
2395
|
params: {
|
|
2396
2396
|
/**
|
|
2397
2397
|
* The ID of the store that owns the order.
|
|
@@ -2413,7 +2413,7 @@ the Ecommerce API.
|
|
|
2413
2413
|
* Create a fulfilment for the order and attach tracking in one call. Omit items to fulfil
|
|
2414
2414
|
every remaining unfulfilled item. Returns the updated order summary.
|
|
2415
2415
|
*/
|
|
2416
|
-
"
|
|
2416
|
+
"ecommerce_orders_fulfil": {
|
|
2417
2417
|
params: {
|
|
2418
2418
|
/**
|
|
2419
2419
|
* The ID of the store that owns the order.
|
|
@@ -2448,7 +2448,7 @@ every remaining unfulfilled item. Returns the updated order summary.
|
|
|
2448
2448
|
status, customer email, order number or a free-text query. Amounts are in the smallest
|
|
2449
2449
|
currency unit. Retrieve a single order for its line items, addresses and fulfilments.
|
|
2450
2450
|
*/
|
|
2451
|
-
"
|
|
2451
|
+
"ecommerce_orders_list-store": {
|
|
2452
2452
|
params: {
|
|
2453
2453
|
/**
|
|
2454
2454
|
* The ID of the store to list orders for.
|
|
@@ -2499,7 +2499,7 @@ currency unit. Retrieve a single order for its line items, addresses and fulfilm
|
|
|
2499
2499
|
addresses, the totals breakdown and fulfilments with tracking. Amounts are in the
|
|
2500
2500
|
smallest currency unit.
|
|
2501
2501
|
*/
|
|
2502
|
-
"
|
|
2502
|
+
"ecommerce_orders_retrieve": {
|
|
2503
2503
|
params: {
|
|
2504
2504
|
/**
|
|
2505
2505
|
* The ID of the store that owns the order.
|
|
@@ -2516,7 +2516,7 @@ smallest currency unit.
|
|
|
2516
2516
|
/**
|
|
2517
2517
|
* Enable a manual payment method so the store can accept orders without an online payment provider.
|
|
2518
2518
|
*/
|
|
2519
|
-
"
|
|
2519
|
+
"ecommerce_payments_enable-manual-method": {
|
|
2520
2520
|
params: {
|
|
2521
2521
|
/**
|
|
2522
2522
|
* The ID of the store to enable manual payment for.
|
|
@@ -2534,7 +2534,7 @@ smallest currency unit.
|
|
|
2534
2534
|
* Create an onboarding link for connecting a payment gateway to the store. Returns the gateway
|
|
2535
2535
|
onboarding URL for the merchant to open and a deep-link into the store admin.
|
|
2536
2536
|
*/
|
|
2537
|
-
"
|
|
2537
|
+
"ecommerce_payments_create-provider-connect-link": {
|
|
2538
2538
|
params: {
|
|
2539
2539
|
/**
|
|
2540
2540
|
* The ID of the store to connect the payment provider to.
|
|
@@ -2552,7 +2552,7 @@ onboarding URL for the merchant to open and a deep-link into the store admin.
|
|
|
2552
2552
|
* List a store's payment providers, split into providers already connected to the store and
|
|
2553
2553
|
gateways available to install. Never exposes gateway credentials, secrets, or configuration.
|
|
2554
2554
|
*/
|
|
2555
|
-
"
|
|
2555
|
+
"ecommerce_payments_list-store-providers": {
|
|
2556
2556
|
params: {
|
|
2557
2557
|
/**
|
|
2558
2558
|
* The ID of the store to list payment providers for.
|
|
@@ -2570,7 +2570,7 @@ gateways available to install. Never exposes gateway credentials, secrets, or co
|
|
|
2570
2570
|
* Returns a signed URL to upload a product image to (multipart/form-data POST). Then call the
|
|
2571
2571
|
attach-image endpoint with the returned object_name to scan and attach it to the product.
|
|
2572
2572
|
*/
|
|
2573
|
-
"
|
|
2573
|
+
"ecommerce_products_create-image-upload-url": {
|
|
2574
2574
|
params: {
|
|
2575
2575
|
/**
|
|
2576
2576
|
* The ID of the store the product belongs to.
|
|
@@ -2588,7 +2588,7 @@ attach-image endpoint with the returned object_name to scan and attach it to the
|
|
|
2588
2588
|
* Delete a product and its variants from the store. A subscription product with active
|
|
2589
2589
|
subscribers is archived instead of deleted so its data stays available.
|
|
2590
2590
|
*/
|
|
2591
|
-
"
|
|
2591
|
+
"ecommerce_products_delete": {
|
|
2592
2592
|
params: {
|
|
2593
2593
|
/**
|
|
2594
2594
|
* The ID of the store that owns the product.
|
|
@@ -2607,7 +2607,7 @@ subscribers is archived instead of deleted so its data stays available.
|
|
|
2607
2607
|
draft to hide it, or archived to retire it. Variants, prices and inventory are managed
|
|
2608
2608
|
through the variant endpoints, not here. Returns the updated product summary.
|
|
2609
2609
|
*/
|
|
2610
|
-
"
|
|
2610
|
+
"ecommerce_products_update": {
|
|
2611
2611
|
params: {
|
|
2612
2612
|
/**
|
|
2613
2613
|
* The ID of the store that owns the product.
|
|
@@ -2636,7 +2636,7 @@ through the variant endpoints, not here. Returns the updated product summary.
|
|
|
2636
2636
|
/**
|
|
2637
2637
|
* Create a published digital product with a single variant and an optional external download link.
|
|
2638
2638
|
*/
|
|
2639
|
-
"
|
|
2639
|
+
"ecommerce_products_create-digital": {
|
|
2640
2640
|
params: {
|
|
2641
2641
|
/**
|
|
2642
2642
|
* The ID of the store to create the product in.
|
|
@@ -2672,7 +2672,7 @@ count and price range). Prices are integers in the smallest currency unit and li
|
|
|
2672
2672
|
variants. Filter by status, free text or a set of product ids. Use include=variants to
|
|
2673
2673
|
embed each product's variants with prices and inventory, and include=media to embed its media.
|
|
2674
2674
|
*/
|
|
2675
|
-
"
|
|
2675
|
+
"ecommerce_products_list": {
|
|
2676
2676
|
params: {
|
|
2677
2677
|
/**
|
|
2678
2678
|
* The ID of the store to list products for.
|
|
@@ -2705,7 +2705,7 @@ embed each product's variants with prices and inventory, and include=media to em
|
|
|
2705
2705
|
/**
|
|
2706
2706
|
* Create a published physical product with a single variant priced in the store currency.
|
|
2707
2707
|
*/
|
|
2708
|
-
"
|
|
2708
|
+
"ecommerce_products_create-physical": {
|
|
2709
2709
|
params: {
|
|
2710
2710
|
/**
|
|
2711
2711
|
* The ID of the store to create the product in.
|
|
@@ -2738,7 +2738,7 @@ is allowed, and its destination must meet the same requirements. Private or rese
|
|
|
2738
2738
|
destinations, unsupported URLs and longer redirect chains are rejected. The image is virus-scanned
|
|
2739
2739
|
and validated by content, then stored on the CDN. Set is_thumbnail to make it the product's primary image.
|
|
2740
2740
|
*/
|
|
2741
|
-
"
|
|
2741
|
+
"ecommerce_products_upload-and-attach-image": {
|
|
2742
2742
|
params: {
|
|
2743
2743
|
/**
|
|
2744
2744
|
* The ID of the store the product belongs to.
|
|
@@ -2773,7 +2773,7 @@ thumbnail only if the product does not have one yet.
|
|
|
2773
2773
|
/**
|
|
2774
2774
|
* List a store's active sales channels with their full metadata.
|
|
2775
2775
|
*/
|
|
2776
|
-
"
|
|
2776
|
+
"ecommerce_sales-channels_list": {
|
|
2777
2777
|
params: {
|
|
2778
2778
|
/**
|
|
2779
2779
|
* The ID of the store to list sales channels for.
|
|
@@ -2788,7 +2788,7 @@ thumbnail only if the product does not have one yet.
|
|
|
2788
2788
|
your catalog, orders, shipping and payments in sync through the Ecommerce API. A "quick-link" channel
|
|
2789
2789
|
is a hosted one-page store whose handle is auto-generated.
|
|
2790
2790
|
*/
|
|
2791
|
-
"
|
|
2791
|
+
"ecommerce_sales-channels_create": {
|
|
2792
2792
|
params: {
|
|
2793
2793
|
/**
|
|
2794
2794
|
* The ID of the store to create the sales channel for.
|
|
@@ -2815,7 +2815,7 @@ is a hosted one-page store whose handle is auto-generated.
|
|
|
2815
2815
|
* Update a custom sales channel. The merchant-facing `name` and the public `url`
|
|
2816
2816
|
(returned as the channel `domain`) can be changed. Pass `null` to clear a value.
|
|
2817
2817
|
*/
|
|
2818
|
-
"
|
|
2818
|
+
"ecommerce_sales-channels_update": {
|
|
2819
2819
|
params: {
|
|
2820
2820
|
/**
|
|
2821
2821
|
* The ID of the store that owns the sales channel.
|
|
@@ -2840,7 +2840,7 @@ is a hosted one-page store whose handle is auto-generated.
|
|
|
2840
2840
|
/**
|
|
2841
2841
|
* Set the flat-rate shipping price for a store, creating the shipping zone if it does not exist yet.
|
|
2842
2842
|
*/
|
|
2843
|
-
"
|
|
2843
|
+
"ecommerce_shipping_set-store": {
|
|
2844
2844
|
params: {
|
|
2845
2845
|
/**
|
|
2846
2846
|
* The ID of the store to configure shipping for.
|
|
@@ -2859,7 +2859,7 @@ is a hosted one-page store whose handle is auto-generated.
|
|
|
2859
2859
|
|
|
2860
2860
|
The underlying store data is preserved; only the store is marked as deleted.
|
|
2861
2861
|
*/
|
|
2862
|
-
"
|
|
2862
|
+
"ecommerce_stores_delete": {
|
|
2863
2863
|
params: {
|
|
2864
2864
|
/**
|
|
2865
2865
|
* The ID of the store to delete.
|
|
@@ -2872,7 +2872,7 @@ The underlying store data is preserved; only the store is marked as deleted.
|
|
|
2872
2872
|
/**
|
|
2873
2873
|
* Retrieve the stores associated with your account.
|
|
2874
2874
|
*/
|
|
2875
|
-
"
|
|
2875
|
+
"ecommerce_stores_list": {
|
|
2876
2876
|
params: {
|
|
2877
2877
|
/**
|
|
2878
2878
|
* Page number
|
|
@@ -2887,7 +2887,7 @@ The underlying store data is preserved; only the store is marked as deleted.
|
|
|
2887
2887
|
|
|
2888
2888
|
A primary sales channel is created alongside the store.
|
|
2889
2889
|
*/
|
|
2890
|
-
"
|
|
2890
|
+
"ecommerce_stores_create": {
|
|
2891
2891
|
params: {
|
|
2892
2892
|
/**
|
|
2893
2893
|
* name parameter
|
|
@@ -2921,7 +2921,7 @@ A primary sales channel is created alongside the store.
|
|
|
2921
2921
|
* Get a store's readiness metadata: whether payment methods and shipping are configured,
|
|
2922
2922
|
plus its default currency. Useful to verify prerequisites before building a storefront.
|
|
2923
2923
|
*/
|
|
2924
|
-
"
|
|
2924
|
+
"ecommerce_stores_metadata": {
|
|
2925
2925
|
params: {
|
|
2926
2926
|
/**
|
|
2927
2927
|
* The ID of the store to read metadata for.
|
|
@@ -2936,7 +2936,7 @@ plus its default currency. Useful to verify prerequisites before building a stor
|
|
|
2936
2936
|
prices. Variants omitted from the request are left untouched. Prices replace the variant's
|
|
2937
2937
|
existing prices in full. Returns the updated variants.
|
|
2938
2938
|
*/
|
|
2939
|
-
"
|
|
2939
|
+
"ecommerce_product-variants_update-in-batch": {
|
|
2940
2940
|
params: {
|
|
2941
2941
|
/**
|
|
2942
2942
|
* The ID of the store that owns the product.
|
|
@@ -2957,7 +2957,7 @@ existing prices in full. Returns the updated variants.
|
|
|
2957
2957
|
/**
|
|
2958
2958
|
* Delete a single variant from the product.
|
|
2959
2959
|
*/
|
|
2960
|
-
"
|
|
2960
|
+
"ecommerce_product-variants_delete": {
|
|
2961
2961
|
params: {
|
|
2962
2962
|
/**
|
|
2963
2963
|
* The ID of the store that owns the product.
|
|
@@ -2979,7 +2979,7 @@ existing prices in full. Returns the updated variants.
|
|
|
2979
2979
|
* List a product's variants, ordered by rank, with their options, prices and inventory.
|
|
2980
2980
|
Prices are integers in the smallest currency unit and live on variants.
|
|
2981
2981
|
*/
|
|
2982
|
-
"
|
|
2982
|
+
"ecommerce_product-variants_list": {
|
|
2983
2983
|
params: {
|
|
2984
2984
|
/**
|
|
2985
2985
|
* The ID of the store that owns the product.
|
|
@@ -3003,7 +3003,7 @@ missing from the product are created automatically; provide a value for every op
|
|
|
3003
3003
|
product already has. Prices are integers in the smallest currency unit and default to the
|
|
3004
3004
|
store currency. Returns the created variant.
|
|
3005
3005
|
*/
|
|
3006
|
-
"
|
|
3006
|
+
"ecommerce_product-variants_create": {
|
|
3007
3007
|
params: {
|
|
3008
3008
|
/**
|
|
3009
3009
|
* The ID of the store that owns the product.
|
|
@@ -3050,7 +3050,7 @@ The original website is left untouched.\n
|
|
|
3050
3050
|
To edit the copy, use the `Edit website` tool with the returned website ID, or the user can
|
|
3051
3051
|
open the provided website URL in Hostinger Horizons interface.
|
|
3052
3052
|
*/
|
|
3053
|
-
"
|
|
3053
|
+
"horizons_websites_clone": {
|
|
3054
3054
|
params: {
|
|
3055
3055
|
/**
|
|
3056
3056
|
* The website ID
|
|
@@ -3068,7 +3068,7 @@ Each website is returned with its ID, status, domain and the URL to open it
|
|
|
3068
3068
|
in Hostinger Horizons interface.\n
|
|
3069
3069
|
The complete list of websites is returned in a single response - it is not paginated.
|
|
3070
3070
|
*/
|
|
3071
|
-
"
|
|
3071
|
+
"horizons_websites_list": {
|
|
3072
3072
|
params: {
|
|
3073
3073
|
|
|
3074
3074
|
};
|
|
@@ -3112,7 +3112,7 @@ MAPS:\n
|
|
|
3112
3112
|
- OpenStreetMap is the default provider.\n
|
|
3113
3113
|
- Alternative providers (Google Maps, Mapbox) are allowed ONLY if explicitly requested by the user.\n
|
|
3114
3114
|
*/
|
|
3115
|
-
"
|
|
3115
|
+
"horizons_websites_create": {
|
|
3116
3116
|
params: {
|
|
3117
3117
|
/**
|
|
3118
3118
|
* message parameter
|
|
@@ -3134,7 +3134,7 @@ Do not write code.\n
|
|
|
3134
3134
|
If the tool call fails with an error, you should provide a clear explanation of the error
|
|
3135
3135
|
and do not generate code yourself in the chat.
|
|
3136
3136
|
*/
|
|
3137
|
-
"
|
|
3137
|
+
"horizons_websites_edit": {
|
|
3138
3138
|
params: {
|
|
3139
3139
|
/**
|
|
3140
3140
|
* The website ID
|
|
@@ -3156,7 +3156,7 @@ Publishing happens asynchronously and takes a few minutes.\n
|
|
|
3156
3156
|
After invoking this tool, your chat reply must be EXACTLY 1 sentence summarizing
|
|
3157
3157
|
that the website is being published and you should provide the published URL to the user immediately.
|
|
3158
3158
|
*/
|
|
3159
|
-
"
|
|
3159
|
+
"horizons_websites_publish": {
|
|
3160
3160
|
params: {
|
|
3161
3161
|
/**
|
|
3162
3162
|
* The website ID
|
|
@@ -3173,7 +3173,7 @@ website URL before or after editing it.\n
|
|
|
3173
3173
|
Websites can be edited with the `Edit website` tool, or by the user in Hostinger Horizons
|
|
3174
3174
|
interface in the provided website URL.
|
|
3175
3175
|
*/
|
|
3176
|
-
"
|
|
3176
|
+
"horizons_websites_get": {
|
|
3177
3177
|
params: {
|
|
3178
3178
|
/**
|
|
3179
3179
|
* The website ID
|
|
@@ -3190,7 +3190,7 @@ updated and needs to be visible immediately, or after making major changes.
|
|
|
3190
3190
|
Also purges the Hostinger CDN cache when CDN is enabled on the website. For a WordPress
|
|
3191
3191
|
installation living in a subdirectory, pass the directory query parameter to clear its cache.
|
|
3192
3192
|
*/
|
|
3193
|
-
"
|
|
3193
|
+
"hosting_cache_clear-website": {
|
|
3194
3194
|
params: {
|
|
3195
3195
|
/**
|
|
3196
3196
|
* username parameter
|
|
@@ -3215,7 +3215,7 @@ is cached, effectively turning off all caching for the website; use it while act
|
|
|
3215
3215
|
testing changes, debugging issues, or when real-time updates must be visible. Disable it after
|
|
3216
3216
|
finishing development work to restore the performance benefits of caching.
|
|
3217
3217
|
*/
|
|
3218
|
-
"
|
|
3218
|
+
"hosting_cache_toggle-cacheless": {
|
|
3219
3219
|
params: {
|
|
3220
3220
|
/**
|
|
3221
3221
|
* username parameter
|
|
@@ -3241,7 +3241,7 @@ debugging, prefer toggling cacheless mode instead.
|
|
|
3241
3241
|
|
|
3242
3242
|
Does nothing if caching is already in the requested state.
|
|
3243
3243
|
*/
|
|
3244
|
-
"
|
|
3244
|
+
"hosting_cache_toggle-website": {
|
|
3245
3245
|
params: {
|
|
3246
3246
|
/**
|
|
3247
3247
|
* username parameter
|
|
@@ -3262,7 +3262,7 @@ Does nothing if caching is already in the requested state.
|
|
|
3262
3262
|
/**
|
|
3263
3263
|
* Returns the list of cron jobs configured for the specified account, including their schedule and command.
|
|
3264
3264
|
*/
|
|
3265
|
-
"
|
|
3265
|
+
"hosting_cron-jobs_list": {
|
|
3266
3266
|
params: {
|
|
3267
3267
|
/**
|
|
3268
3268
|
* username parameter
|
|
@@ -3277,7 +3277,7 @@ Does nothing if caching is already in the requested state.
|
|
|
3277
3277
|
|
|
3278
3278
|
Returns the created cron job, including its uid, which is required to delete the cron job or fetch its output.
|
|
3279
3279
|
*/
|
|
3280
|
-
"
|
|
3280
|
+
"hosting_cron-jobs_create": {
|
|
3281
3281
|
params: {
|
|
3282
3282
|
/**
|
|
3283
3283
|
* username parameter
|
|
@@ -3300,7 +3300,7 @@ Returns the created cron job, including its uid, which is required to delete the
|
|
|
3300
3300
|
|
|
3301
3301
|
The uid is returned by the list cron jobs endpoint.
|
|
3302
3302
|
*/
|
|
3303
|
-
"
|
|
3303
|
+
"hosting_cron-jobs_delete": {
|
|
3304
3304
|
params: {
|
|
3305
3305
|
/**
|
|
3306
3306
|
* username parameter
|
|
@@ -3319,7 +3319,7 @@ The uid is returned by the list cron jobs endpoint.
|
|
|
3319
3319
|
|
|
3320
3320
|
The uid is returned by the list cron jobs endpoint.
|
|
3321
3321
|
*/
|
|
3322
|
-
"
|
|
3322
|
+
"hosting_cron-jobs_output": {
|
|
3323
3323
|
params: {
|
|
3324
3324
|
/**
|
|
3325
3325
|
* username parameter
|
|
@@ -3339,7 +3339,7 @@ The uid is returned by the list cron jobs endpoint.
|
|
|
3339
3339
|
The database name must be the full name returned by the list databases endpoint.
|
|
3340
3340
|
The password must also be updated in any website configuration that uses this database.
|
|
3341
3341
|
*/
|
|
3342
|
-
"
|
|
3342
|
+
"hosting_databases_change-password": {
|
|
3343
3343
|
params: {
|
|
3344
3344
|
/**
|
|
3345
3345
|
* username parameter
|
|
@@ -3362,7 +3362,7 @@ The password must also be updated in any website configuration that uses this da
|
|
|
3362
3362
|
|
|
3363
3363
|
Use the domain and is_assigned filters to find databases assigned to a specific domain.
|
|
3364
3364
|
*/
|
|
3365
|
-
"
|
|
3365
|
+
"hosting_databases_list": {
|
|
3366
3366
|
params: {
|
|
3367
3367
|
/**
|
|
3368
3368
|
* username parameter
|
|
@@ -3397,7 +3397,7 @@ Use the domain and is_assigned filters to find databases assigned to a specific
|
|
|
3397
3397
|
|
|
3398
3398
|
The database name and user are automatically prefixed with the account username when needed.
|
|
3399
3399
|
*/
|
|
3400
|
-
"
|
|
3400
|
+
"hosting_databases_create": {
|
|
3401
3401
|
params: {
|
|
3402
3402
|
/**
|
|
3403
3403
|
* username parameter
|
|
@@ -3428,7 +3428,7 @@ The database name and user are automatically prefixed with the account username
|
|
|
3428
3428
|
|
|
3429
3429
|
The database name must be the full name returned by the list databases endpoint.
|
|
3430
3430
|
*/
|
|
3431
|
-
"
|
|
3431
|
+
"hosting_databases_delete": {
|
|
3432
3432
|
params: {
|
|
3433
3433
|
/**
|
|
3434
3434
|
* username parameter
|
|
@@ -3448,7 +3448,7 @@ The database name must be the full name returned by the list databases endpoint.
|
|
|
3448
3448
|
Provide an IPv4/IPv6 address, or "%" to allow any host. The database name must be
|
|
3449
3449
|
the full name returned by the list databases endpoint.
|
|
3450
3450
|
*/
|
|
3451
|
-
"
|
|
3451
|
+
"hosting_databases_create-remote-connection": {
|
|
3452
3452
|
params: {
|
|
3453
3453
|
/**
|
|
3454
3454
|
* username parameter
|
|
@@ -3473,7 +3473,7 @@ Identify the rule with the required ip query parameter (the IPv4/IPv6 address, o
|
|
|
3473
3473
|
exactly as returned by the list remote connections endpoint). The database name must be
|
|
3474
3474
|
the full name returned by the list databases endpoint.
|
|
3475
3475
|
*/
|
|
3476
|
-
"
|
|
3476
|
+
"hosting_databases_delete-remote-connection": {
|
|
3477
3477
|
params: {
|
|
3478
3478
|
/**
|
|
3479
3479
|
* username parameter
|
|
@@ -3498,7 +3498,7 @@ exactly as returned by the list remote connections endpoint.
|
|
|
3498
3498
|
|
|
3499
3499
|
Use the domain filter to only return rules for databases assigned to a specific domain.
|
|
3500
3500
|
*/
|
|
3501
|
-
"
|
|
3501
|
+
"hosting_databases_list-remote-connections": {
|
|
3502
3502
|
params: {
|
|
3503
3503
|
/**
|
|
3504
3504
|
* username parameter
|
|
@@ -3519,7 +3519,7 @@ Rules for databases not assigned to any domain are always included.
|
|
|
3519
3519
|
Use when database errors, crashes, or corruption are reported.
|
|
3520
3520
|
The database name must be the full name returned by the list databases endpoint.
|
|
3521
3521
|
*/
|
|
3522
|
-
"
|
|
3522
|
+
"hosting_databases_repair": {
|
|
3523
3523
|
params: {
|
|
3524
3524
|
/**
|
|
3525
3525
|
* username parameter
|
|
@@ -3555,7 +3555,7 @@ Express or NestJS. Frameworks that bake variables into the build output (Next.js
|
|
|
3555
3555
|
A password in the request is ignored; the platform always generates it. The optional `name`
|
|
3556
3556
|
and `user` are identifiers, not secrets.
|
|
3557
3557
|
*/
|
|
3558
|
-
"
|
|
3558
|
+
"hosting_databases_setup-website": {
|
|
3559
3559
|
params: {
|
|
3560
3560
|
/**
|
|
3561
3561
|
* username parameter
|
|
@@ -3589,7 +3589,7 @@ the full user is 12 to 25 characters.
|
|
|
3589
3589
|
Use this when a visual database interface is needed for SQL queries, imports, exports, or table management.
|
|
3590
3590
|
The database name must be the full name returned by the list databases endpoint.
|
|
3591
3591
|
*/
|
|
3592
|
-
"
|
|
3592
|
+
"hosting_databases_phpmyadmin-link": {
|
|
3593
3593
|
params: {
|
|
3594
3594
|
/**
|
|
3595
3595
|
* username parameter
|
|
@@ -3609,7 +3609,7 @@ based on available datacenter capacity and hosting plan of your order.
|
|
|
3609
3609
|
The first item in the list is the best match for your specific order
|
|
3610
3610
|
requirements.
|
|
3611
3611
|
*/
|
|
3612
|
-
"
|
|
3612
|
+
"hosting_datacenters_list": {
|
|
3613
3613
|
params: {
|
|
3614
3614
|
/**
|
|
3615
3615
|
* Order ID
|
|
@@ -3624,7 +3624,7 @@ requirements.
|
|
|
3624
3624
|
Free subdomains allow you to start using hosting services immediately
|
|
3625
3625
|
and you can always connect a custom domain to your site later.
|
|
3626
3626
|
*/
|
|
3627
|
-
"
|
|
3627
|
+
"hosting_domains_generate-free-subdomain": {
|
|
3628
3628
|
params: {
|
|
3629
3629
|
|
|
3630
3630
|
};
|
|
@@ -3637,7 +3637,7 @@ and you can always connect a custom domain to your site later.
|
|
|
3637
3637
|
Use this endpoint to inspect parked domain configuration for a specific website,
|
|
3638
3638
|
including the parent domain and root directory assigned to each parked domain.
|
|
3639
3639
|
*/
|
|
3640
|
-
"
|
|
3640
|
+
"hosting_domains_list-website-parked": {
|
|
3641
3641
|
params: {
|
|
3642
3642
|
/**
|
|
3643
3643
|
* username parameter
|
|
@@ -3657,7 +3657,7 @@ including the parent domain and root directory assigned to each parked domain.
|
|
|
3657
3657
|
Provide a domain name or IP address to park on the website so it serves the same content
|
|
3658
3658
|
as the parent domain.
|
|
3659
3659
|
*/
|
|
3660
|
-
"
|
|
3660
|
+
"hosting_domains_create-website-parked": {
|
|
3661
3661
|
params: {
|
|
3662
3662
|
/**
|
|
3663
3663
|
* username parameter
|
|
@@ -3680,7 +3680,7 @@ as the parent domain.
|
|
|
3680
3680
|
|
|
3681
3681
|
Use this endpoint to remove parked domains that are no longer needed.
|
|
3682
3682
|
*/
|
|
3683
|
-
"
|
|
3683
|
+
"hosting_domains_delete-website-parked": {
|
|
3684
3684
|
params: {
|
|
3685
3685
|
/**
|
|
3686
3686
|
* username parameter
|
|
@@ -3704,7 +3704,7 @@ Use this endpoint to remove parked domains that are no longer needed.
|
|
|
3704
3704
|
Use this endpoint to inspect subdomain configuration for a specific website,
|
|
3705
3705
|
including the parent domain and root directory assigned to each subdomain.
|
|
3706
3706
|
*/
|
|
3707
|
-
"
|
|
3707
|
+
"hosting_domains_list-website-subdomains": {
|
|
3708
3708
|
params: {
|
|
3709
3709
|
/**
|
|
3710
3710
|
* username parameter
|
|
@@ -3724,7 +3724,7 @@ including the parent domain and root directory assigned to each subdomain.
|
|
|
3724
3724
|
Provide a subdomain prefix and, optionally, a custom directory or the
|
|
3725
3725
|
website public directory to use as the subdomain root.
|
|
3726
3726
|
*/
|
|
3727
|
-
"
|
|
3727
|
+
"hosting_domains_create-website-subdomain": {
|
|
3728
3728
|
params: {
|
|
3729
3729
|
/**
|
|
3730
3730
|
* username parameter
|
|
@@ -3755,7 +3755,7 @@ website public directory to use as the subdomain root.
|
|
|
3755
3755
|
|
|
3756
3756
|
Use this endpoint to remove subdomains that are no longer needed.
|
|
3757
3757
|
*/
|
|
3758
|
-
"
|
|
3758
|
+
"hosting_domains_delete-website-subdomain": {
|
|
3759
3759
|
params: {
|
|
3760
3760
|
/**
|
|
3761
3761
|
* username parameter
|
|
@@ -3783,7 +3783,7 @@ Keep in mind that it may take up to 10 minutes for new TXT DNS records to propag
|
|
|
3783
3783
|
|
|
3784
3784
|
Skip this verification when using Hostinger's free subdomains (*.hostingersite.com).
|
|
3785
3785
|
*/
|
|
3786
|
-
"
|
|
3786
|
+
"hosting_domains_verify-ownership": {
|
|
3787
3787
|
params: {
|
|
3788
3788
|
/**
|
|
3789
3789
|
* Domain to verify ownership for
|
|
@@ -3832,7 +3832,7 @@ curl -i -X PATCH "{url}/${FILE}?override=true" \
|
|
|
3832
3832
|
# -> 204 No Content, Upload-Offset response header equals SIZE when done
|
|
3833
3833
|
```
|
|
3834
3834
|
*/
|
|
3835
|
-
"
|
|
3835
|
+
"hosting_files_generate-upload-url": {
|
|
3836
3836
|
params: {
|
|
3837
3837
|
/**
|
|
3838
3838
|
* Account username
|
|
@@ -3852,7 +3852,7 @@ curl -i -X PATCH "{url}/${FILE}?override=true" \
|
|
|
3852
3852
|
Use `directory` to browse a subdirectory relative to the document root. Symlinked entries
|
|
3853
3853
|
are listed but never traversed into or resolved.
|
|
3854
3854
|
*/
|
|
3855
|
-
"
|
|
3855
|
+
"hosting_files_list-website-and-directories": {
|
|
3856
3856
|
params: {
|
|
3857
3857
|
/**
|
|
3858
3858
|
* username parameter
|
|
@@ -3892,7 +3892,7 @@ are listed but never traversed into or resolved.
|
|
|
3892
3892
|
Read-only; refuses symlinks, oversized files, non-text file types, and files identified as
|
|
3893
3893
|
containing secrets (e.g. credential files) — none of these are returned by this endpoint.
|
|
3894
3894
|
*/
|
|
3895
|
-
"
|
|
3895
|
+
"hosting_files_website-content": {
|
|
3896
3896
|
params: {
|
|
3897
3897
|
/**
|
|
3898
3898
|
* username parameter
|
|
@@ -3926,7 +3926,7 @@ repository link but ignores pushes.
|
|
|
3926
3926
|
When the website has no auto-deployment configured every field is null. Save settings with
|
|
3927
3927
|
`Update Git auto-deployment settings`.
|
|
3928
3928
|
*/
|
|
3929
|
-
"
|
|
3929
|
+
"hosting_git_auto-deployment-settings": {
|
|
3930
3930
|
params: {
|
|
3931
3931
|
/**
|
|
3932
3932
|
* username parameter
|
|
@@ -3953,7 +3953,7 @@ does not clone anything. On a Node.js website start the first deploy with
|
|
|
3953
3953
|
`Start Node.js build` using `source_type` `git`; pushes then trigger new builds with the build
|
|
3954
3954
|
settings stored for the website.
|
|
3955
3955
|
*/
|
|
3956
|
-
"
|
|
3956
|
+
"hosting_git_update-auto-deployment-settings": {
|
|
3957
3957
|
params: {
|
|
3958
3958
|
/**
|
|
3959
3959
|
* username parameter
|
|
@@ -3998,7 +3998,7 @@ the document root.
|
|
|
3998
3998
|
website; pushes stop deploying until settings are saved again. Succeeds also when nothing is
|
|
3999
3999
|
configured.
|
|
4000
4000
|
*/
|
|
4001
|
-
"
|
|
4001
|
+
"hosting_git_delete-auto-deployment-settings": {
|
|
4002
4002
|
params: {
|
|
4003
4003
|
/**
|
|
4004
4004
|
* username parameter
|
|
@@ -4025,7 +4025,7 @@ Use `uuid` as the path parameter of `List Git installation repositories`, and as
|
|
|
4025
4025
|
`installation_uuid` in `Start Node.js build` with `source_type` `git` and in
|
|
4026
4026
|
`Update Git auto-deployment settings`.
|
|
4027
4027
|
*/
|
|
4028
|
-
"
|
|
4028
|
+
"hosting_git_list-installations": {
|
|
4029
4029
|
params: {
|
|
4030
4030
|
/**
|
|
4031
4031
|
* Filter by Git provider
|
|
@@ -4051,7 +4051,7 @@ more, name the repository directly instead of searching this list.
|
|
|
4051
4051
|
installation does not belong to the customer. Limited to 10 calls per minute per API client
|
|
4052
4052
|
(429 above that).
|
|
4053
4053
|
*/
|
|
4054
|
-
"
|
|
4054
|
+
"hosting_git_list-installation-repositories": {
|
|
4055
4055
|
params: {
|
|
4056
4056
|
/**
|
|
4057
4057
|
* Git installation UUID from the List Git installations endpoint
|
|
@@ -4068,7 +4068,7 @@ Each build represents a single run of the Node.js build pipeline. Use the `state
|
|
|
4068
4068
|
query parameter to filter results by build state (pending, running, completed, failed).
|
|
4069
4069
|
Use the `uuid` from a build to poll its output via the `Get Node.js Build Logs` endpoint.
|
|
4070
4070
|
*/
|
|
4071
|
-
"
|
|
4071
|
+
"hosting_nodejs_list-builds": {
|
|
4072
4072
|
params: {
|
|
4073
4073
|
/**
|
|
4074
4074
|
* username parameter
|
|
@@ -4114,7 +4114,7 @@ head. The installation must belong to the same customer as the website.
|
|
|
4114
4114
|
The returned build `uuid` can be used to poll progress and retrieve logs via
|
|
4115
4115
|
the `Get Node.js Build Logs` endpoint.
|
|
4116
4116
|
*/
|
|
4117
|
-
"
|
|
4117
|
+
"hosting_nodejs_start-build": {
|
|
4118
4118
|
params: {
|
|
4119
4119
|
/**
|
|
4120
4120
|
* username parameter
|
|
@@ -4177,7 +4177,7 @@ Returns 404 until the first build or the first settings update stores them. Use
|
|
|
4177
4177
|
a failed build to check whether the framework or the entry file were detected wrong, then
|
|
4178
4178
|
fix them with the `Update Node.js build settings` endpoint.
|
|
4179
4179
|
*/
|
|
4180
|
-
"
|
|
4180
|
+
"hosting_nodejs_build-settings": {
|
|
4181
4181
|
params: {
|
|
4182
4182
|
/**
|
|
4183
4183
|
* username parameter
|
|
@@ -4202,7 +4202,7 @@ settings call `Start Node.js build` with the same values. Typical fixes: a wrong
|
|
|
4202
4202
|
after auto-detection, or a missing `entry_file` for express, fastify, nest, nuxt and hono
|
|
4203
4203
|
apps.
|
|
4204
4204
|
*/
|
|
4205
|
-
"
|
|
4205
|
+
"hosting_nodejs_update-build-settings": {
|
|
4206
4206
|
params: {
|
|
4207
4207
|
/**
|
|
4208
4208
|
* username parameter
|
|
@@ -4256,7 +4256,7 @@ output directory, build script) before committing to a build.
|
|
|
4256
4256
|
The archive must already be present on the website's file storage. Use the
|
|
4257
4257
|
`Generate Upload URL` endpoint to obtain credentials and upload the archive first.
|
|
4258
4258
|
*/
|
|
4259
|
-
"
|
|
4259
|
+
"hosting_nodejs_build-settings-from-archive": {
|
|
4260
4260
|
params: {
|
|
4261
4261
|
/**
|
|
4262
4262
|
* username parameter
|
|
@@ -4284,7 +4284,7 @@ the whole set, so never copy the masked values from this response into that requ
|
|
|
4284
4284
|
the full desired set with real values taken from the project `.env` file or the user
|
|
4285
4285
|
prompt instead.
|
|
4286
4286
|
*/
|
|
4287
|
-
"
|
|
4287
|
+
"hosting_nodejs_list-environment-variables": {
|
|
4288
4288
|
params: {
|
|
4289
4289
|
/**
|
|
4290
4290
|
* username parameter
|
|
@@ -4314,7 +4314,7 @@ The `List Node.js environment variables` endpoint returns masked values (`******
|
|
|
4314
4314
|
never copy values from it into this request. Always send the full desired set with real
|
|
4315
4315
|
values taken from the project `.env` file or the user prompt.
|
|
4316
4316
|
*/
|
|
4317
|
-
"
|
|
4317
|
+
"hosting_nodejs_replace-environment-variables": {
|
|
4318
4318
|
params: {
|
|
4319
4319
|
/**
|
|
4320
4320
|
* username parameter
|
|
@@ -4342,7 +4342,7 @@ any other state returns 422. When no analysis could be produced both `analysis`
|
|
|
4342
4342
|
Each call runs the analysis again, so call it once per failed build and keep the result.
|
|
4343
4343
|
Limited to 5 calls per minute per API client (429 above that).
|
|
4344
4344
|
*/
|
|
4345
|
-
"
|
|
4345
|
+
"hosting_nodejs_analyse-failed-build": {
|
|
4346
4346
|
params: {
|
|
4347
4347
|
/**
|
|
4348
4348
|
* username parameter
|
|
@@ -4366,7 +4366,7 @@ options it ran with and timestamps. Poll this while a build is pending or runnin
|
|
|
4366
4366
|
is failed, read `Get NodeJS build logs` and `Analyse failed Node.js build` for the cause.
|
|
4367
4367
|
Returns 404 when the UUID does not belong to a build of this website.
|
|
4368
4368
|
*/
|
|
4369
|
-
"
|
|
4369
|
+
"hosting_nodejs_build": {
|
|
4370
4370
|
params: {
|
|
4371
4371
|
/**
|
|
4372
4372
|
* username parameter
|
|
@@ -4392,7 +4392,7 @@ while the build state is `running`, passing the previously returned `lines` coun
|
|
|
4392
4392
|
as `from_line` to fetch only new output since the last call.
|
|
4393
4393
|
Log content may contain ANSI escape sequences (color codes).
|
|
4394
4394
|
*/
|
|
4395
|
-
"
|
|
4395
|
+
"hosting_nodejs_build-logs": {
|
|
4396
4396
|
params: {
|
|
4397
4397
|
/**
|
|
4398
4398
|
* username parameter
|
|
@@ -4427,7 +4427,7 @@ entries while `total_lines` counts every raw line. Entries with a timestamp befo
|
|
|
4427
4427
|
`last_deployed_at` belong to the previous deployment. Returns an empty `logs` list when
|
|
4428
4428
|
the application has not written a log file yet.
|
|
4429
4429
|
*/
|
|
4430
|
-
"
|
|
4430
|
+
"hosting_nodejs_runtime-logs": {
|
|
4431
4431
|
params: {
|
|
4432
4432
|
/**
|
|
4433
4433
|
* username parameter
|
|
@@ -4468,7 +4468,7 @@ Use it before reproducing a problem so the next `Get Node.js runtime logs` call
|
|
|
4468
4468
|
only fresh entries; start that call with `period` again instead of reusing a `from_line`
|
|
4469
4469
|
from before the clear.
|
|
4470
4470
|
*/
|
|
4471
|
-
"
|
|
4471
|
+
"hosting_nodejs_clear-runtime-logs": {
|
|
4472
4472
|
params: {
|
|
4473
4473
|
/**
|
|
4474
4474
|
* username parameter
|
|
@@ -4491,7 +4491,7 @@ Only applicable to server-side applications (Express, Next.js, NestJS, etc.). St
|
|
|
4491
4491
|
front-end apps (React, Vue, Vite) have no persistent server process, so restarting them
|
|
4492
4492
|
has no effect. Returns success even when the website has no server process to restart.
|
|
4493
4493
|
*/
|
|
4494
|
-
"
|
|
4494
|
+
"hosting_nodejs_restart-application": {
|
|
4495
4495
|
params: {
|
|
4496
4496
|
/**
|
|
4497
4497
|
* username parameter
|
|
@@ -4524,7 +4524,7 @@ An empty list means the most recent scan found no vulnerabilities; it does not
|
|
|
4524
4524
|
guarantee the current deployment is vulnerability-free. Available on Business and
|
|
4525
4525
|
Cloud Hosting plans.
|
|
4526
4526
|
*/
|
|
4527
|
-
"
|
|
4527
|
+
"hosting_nodejs_list-vulnerabilities": {
|
|
4528
4528
|
params: {
|
|
4529
4529
|
/**
|
|
4530
4530
|
* username parameter
|
|
@@ -4558,7 +4558,7 @@ in `patched_vulnerability_ids`. Selections without any patchable vulnerability a
|
|
|
4558
4558
|
rejected with a 422. Only one patch pull request can be open at a time per website;
|
|
4559
4559
|
close or merge it before patching again. Available on Business and Cloud Hosting plans.
|
|
4560
4560
|
*/
|
|
4561
|
-
"
|
|
4561
|
+
"hosting_nodejs_patch-vulnerabilities": {
|
|
4562
4562
|
params: {
|
|
4563
4563
|
/**
|
|
4564
4564
|
* username parameter
|
|
@@ -4585,7 +4585,7 @@ of other client hosting accounts that have shared access with you.
|
|
|
4585
4585
|
Use the available query parameters to filter results by order statuses
|
|
4586
4586
|
or specific order IDs for more targeted results.
|
|
4587
4587
|
*/
|
|
4588
|
-
"
|
|
4588
|
+
"hosting_orders_list": {
|
|
4589
4589
|
params: {
|
|
4590
4590
|
/**
|
|
4591
4591
|
* Page number
|
|
@@ -4612,7 +4612,7 @@ or specific order IDs for more targeted results.
|
|
|
4612
4612
|
|
|
4613
4613
|
Use it to recover from extension conflicts or restore the original configuration.
|
|
4614
4614
|
*/
|
|
4615
|
-
"
|
|
4615
|
+
"hosting_php_reset-extensions": {
|
|
4616
4616
|
params: {
|
|
4617
4617
|
/**
|
|
4618
4618
|
* username parameter
|
|
@@ -4633,7 +4633,7 @@ default, type and the plan limit (`max`), and conflicting extension groups.
|
|
|
4633
4633
|
|
|
4634
4634
|
Use it to check the current PHP setup before updating the version, extensions or options.
|
|
4635
4635
|
*/
|
|
4636
|
-
"
|
|
4636
|
+
"hosting_php_get": {
|
|
4637
4637
|
params: {
|
|
4638
4638
|
/**
|
|
4639
4639
|
* username parameter
|
|
@@ -4652,7 +4652,7 @@ Use it to check the current PHP setup before updating the version, extensions or
|
|
|
4652
4652
|
|
|
4653
4653
|
Use it to debug PHP issues or inspect the complete PHP environment of the website.
|
|
4654
4654
|
*/
|
|
4655
|
-
"
|
|
4655
|
+
"hosting_php_info": {
|
|
4656
4656
|
params: {
|
|
4657
4657
|
/**
|
|
4658
4658
|
* username parameter
|
|
@@ -4671,7 +4671,7 @@ Use it to debug PHP issues or inspect the complete PHP environment of the websit
|
|
|
4671
4671
|
|
|
4672
4672
|
Use the Get PHP details endpoint to check the current extension states before changing them.
|
|
4673
4673
|
*/
|
|
4674
|
-
"
|
|
4674
|
+
"hosting_php_update-extensions": {
|
|
4675
4675
|
params: {
|
|
4676
4676
|
/**
|
|
4677
4677
|
* username parameter
|
|
@@ -4700,7 +4700,7 @@ Only provide the options you want to change, inside the `options` object.
|
|
|
4700
4700
|
Values above the account plan limit are silently capped to that limit, so the request can succeed
|
|
4701
4701
|
with a smaller applied value. Call the Get PHP details endpoint afterwards to read the applied value.
|
|
4702
4702
|
*/
|
|
4703
|
-
"
|
|
4703
|
+
"hosting_php_update-options": {
|
|
4704
4704
|
params: {
|
|
4705
4705
|
/**
|
|
4706
4706
|
* username parameter
|
|
@@ -4723,7 +4723,7 @@ with a smaller applied value. Call the Get PHP details endpoint afterwards to re
|
|
|
4723
4723
|
|
|
4724
4724
|
Use the Get PHP details endpoint to see the versions available for the website.
|
|
4725
4725
|
*/
|
|
4726
|
-
"
|
|
4726
|
+
"hosting_php_update-version": {
|
|
4727
4727
|
params: {
|
|
4728
4728
|
/**
|
|
4729
4729
|
* username parameter
|
|
@@ -4744,7 +4744,7 @@ Use the Get PHP details endpoint to see the versions available for the website.
|
|
|
4744
4744
|
/**
|
|
4745
4745
|
* Returns a paginated list of redirects configured for the selected website.
|
|
4746
4746
|
*/
|
|
4747
|
-
"
|
|
4747
|
+
"hosting_redirects_list-website": {
|
|
4748
4748
|
params: {
|
|
4749
4749
|
/**
|
|
4750
4750
|
* username parameter
|
|
@@ -4769,7 +4769,7 @@ Use the Get PHP details endpoint to see the versions available for the website.
|
|
|
4769
4769
|
/**
|
|
4770
4770
|
* Creates a redirect from a URL on the selected website to another URL or IP address.
|
|
4771
4771
|
*/
|
|
4772
|
-
"
|
|
4772
|
+
"hosting_redirects_create-website": {
|
|
4773
4773
|
params: {
|
|
4774
4774
|
/**
|
|
4775
4775
|
* username parameter
|
|
@@ -4796,7 +4796,7 @@ Use the Get PHP details endpoint to see the versions available for the website.
|
|
|
4796
4796
|
|
|
4797
4797
|
Pass the `from` value exactly as returned by the list redirects endpoint.
|
|
4798
4798
|
*/
|
|
4799
|
-
"
|
|
4799
|
+
"hosting_redirects_delete-website": {
|
|
4800
4800
|
params: {
|
|
4801
4801
|
/**
|
|
4802
4802
|
* username parameter
|
|
@@ -4825,7 +4825,7 @@ installation is `installing` or `waiting_for_retry`, when the website's certific
|
|
|
4825
4825
|
revoked (it cannot be reissued), and when an uploaded custom certificate is installed; that
|
|
4826
4826
|
one has to be uninstalled first.
|
|
4827
4827
|
*/
|
|
4828
|
-
"
|
|
4828
|
+
"hosting_ssl_install": {
|
|
4829
4829
|
params: {
|
|
4830
4830
|
/**
|
|
4831
4831
|
* username parameter
|
|
@@ -4851,7 +4851,7 @@ means the assigned certificate's validity has ended. `not_installed` means no ce
|
|
|
4851
4851
|
assigned. Free subdomains use a platform-managed certificate: with no installation recorded
|
|
4852
4852
|
they report `active` with `provider` and `expires_at` null.
|
|
4853
4853
|
*/
|
|
4854
|
-
"
|
|
4854
|
+
"hosting_ssl_status": {
|
|
4855
4855
|
params: {
|
|
4856
4856
|
/**
|
|
4857
4857
|
* username parameter
|
|
@@ -4871,7 +4871,7 @@ nothing when the redirect is already in the requested state. Turning it on requi
|
|
|
4871
4871
|
installed certificate (`status` `active` or `expired` on `Get SSL status`) and returns 422
|
|
4872
4872
|
when there is none; turning it off is always accepted.
|
|
4873
4873
|
*/
|
|
4874
|
-
"
|
|
4874
|
+
"hosting_ssl_toggle-https-redirect": {
|
|
4875
4875
|
params: {
|
|
4876
4876
|
/**
|
|
4877
4877
|
* username parameter
|
|
@@ -4898,7 +4898,7 @@ succeeds when no certificate is assigned, so repeating it is safe.
|
|
|
4898
4898
|
Returns 422 for free subdomains (their certificate is managed by the platform) and while an
|
|
4899
4899
|
installation is `installing`.
|
|
4900
4900
|
*/
|
|
4901
|
-
"
|
|
4901
|
+
"hosting_ssl_uninstall": {
|
|
4902
4902
|
params: {
|
|
4903
4903
|
/**
|
|
4904
4904
|
* username parameter
|
|
@@ -4932,7 +4932,7 @@ WordPress websites (`website_types=wordpress`) or only Node.js websites
|
|
|
4932
4932
|
filter by username, order ID, enabled status, or domain name for more targeted
|
|
4933
4933
|
results.
|
|
4934
4934
|
*/
|
|
4935
|
-
"
|
|
4935
|
+
"hosting_websites_list": {
|
|
4936
4936
|
params: {
|
|
4937
4937
|
/**
|
|
4938
4938
|
* Page number
|
|
@@ -4982,7 +4982,7 @@ Subsequent websites will be hosted on the same datacenter automatically.
|
|
|
4982
4982
|
Website creation takes up to a few minutes to complete. Check the
|
|
4983
4983
|
websites list endpoint to see when your new website becomes available.
|
|
4984
4984
|
*/
|
|
4985
|
-
"
|
|
4985
|
+
"hosting_websites_create": {
|
|
4986
4986
|
params: {
|
|
4987
4987
|
/**
|
|
4988
4988
|
* Domain name for the website. Cannot start with "www."
|
|
@@ -5014,7 +5014,7 @@ Node.js applications, use `Create NodeJS build from archive` instead, or
|
|
|
5014
5014
|
`Start Node.js build` if the archive is already uploaded. For WordPress sites,
|
|
5015
5015
|
use `Import WordPress website`.
|
|
5016
5016
|
*/
|
|
5017
|
-
"
|
|
5017
|
+
"hosting_websites_deploy-static-site-archive": {
|
|
5018
5018
|
params: {
|
|
5019
5019
|
/**
|
|
5020
5020
|
* username parameter
|
|
@@ -5051,7 +5051,7 @@ authenticated client.
|
|
|
5051
5051
|
Website removal is processed asynchronously and can take a few minutes to
|
|
5052
5052
|
complete. The response returns before the removal finishes.
|
|
5053
5053
|
*/
|
|
5054
|
-
"
|
|
5054
|
+
"hosting_websites_delete": {
|
|
5055
5055
|
params: {
|
|
5056
5056
|
/**
|
|
5057
5057
|
* Domain name
|
|
@@ -5066,7 +5066,7 @@ complete. The response returns before the removal finishes.
|
|
|
5066
5066
|
from the given local part and the domain of the mailbox. Messages
|
|
5067
5067
|
sent to the alias are delivered to the mailbox.
|
|
5068
5068
|
*/
|
|
5069
|
-
"
|
|
5069
|
+
"mail_aliases_create-alias": {
|
|
5070
5070
|
params: {
|
|
5071
5071
|
/**
|
|
5072
5072
|
* Mailbox resource ID
|
|
@@ -5084,7 +5084,7 @@ sent to the alias are delivered to the mailbox.
|
|
|
5084
5084
|
* Delete an alias. Messages sent to the alias address are no longer
|
|
5085
5085
|
delivered to the mailbox.
|
|
5086
5086
|
*/
|
|
5087
|
-
"
|
|
5087
|
+
"mail_aliases_delete-alias": {
|
|
5088
5088
|
params: {
|
|
5089
5089
|
/**
|
|
5090
5090
|
* Alias resource ID
|
|
@@ -5098,7 +5098,7 @@ delivered to the mailbox.
|
|
|
5098
5098
|
* Retrieve a paginated list of aliases across all mailboxes of a mail
|
|
5099
5099
|
order.
|
|
5100
5100
|
*/
|
|
5101
|
-
"
|
|
5101
|
+
"mail_aliases_list": {
|
|
5102
5102
|
params: {
|
|
5103
5103
|
/**
|
|
5104
5104
|
* Order resource ID
|
|
@@ -5126,7 +5126,7 @@ A maximum of 10 tokens can exist per order. Use
|
|
|
5126
5126
|
`scope.has_all_mailboxes` to cover all current and future mailboxes,
|
|
5127
5127
|
or list specific mailboxes in `scope.mailbox_ids`.
|
|
5128
5128
|
*/
|
|
5129
|
-
"
|
|
5129
|
+
"mail_api-tokens_create": {
|
|
5130
5130
|
params: {
|
|
5131
5131
|
/**
|
|
5132
5132
|
* Order resource ID
|
|
@@ -5149,7 +5149,7 @@ or list specific mailboxes in `scope.mailbox_ids`.
|
|
|
5149
5149
|
[Hostinger Email API](https://api.mail.hostinger.com/). This action
|
|
5150
5150
|
cannot be undone.
|
|
5151
5151
|
*/
|
|
5152
|
-
"
|
|
5152
|
+
"mail_api-tokens_revoke": {
|
|
5153
5153
|
params: {
|
|
5154
5154
|
/**
|
|
5155
5155
|
* API token ID (returned when the token was created)
|
|
@@ -5165,7 +5165,7 @@ cannot be undone.
|
|
|
5165
5165
|
all your mail orders, optionally filtered by order. Plaintext tokens
|
|
5166
5166
|
are never included; they are returned only when a token is created.
|
|
5167
5167
|
*/
|
|
5168
|
-
"
|
|
5168
|
+
"mail_api-tokens_list": {
|
|
5169
5169
|
params: {
|
|
5170
5170
|
/**
|
|
5171
5171
|
* Filter tokens by order resource ID. Single value or comma-separated list.
|
|
@@ -5188,7 +5188,7 @@ are never included; they are returned only when a token is created.
|
|
|
5188
5188
|
only one autoreply. Omit `starts_at` to activate the autoreply
|
|
5189
5189
|
immediately and omit `ends_at` to keep it active indefinitely.
|
|
5190
5190
|
*/
|
|
5191
|
-
"
|
|
5191
|
+
"mail_autoreplies_create": {
|
|
5192
5192
|
params: {
|
|
5193
5193
|
/**
|
|
5194
5194
|
* Mailbox resource ID
|
|
@@ -5224,7 +5224,7 @@ optional fields are cleared: omit `starts_at` to activate the
|
|
|
5224
5224
|
autoreply immediately and omit `ends_at` to keep it active
|
|
5225
5225
|
indefinitely.
|
|
5226
5226
|
*/
|
|
5227
|
-
"
|
|
5227
|
+
"mail_autoreplies_update": {
|
|
5228
5228
|
params: {
|
|
5229
5229
|
/**
|
|
5230
5230
|
* Autoreply resource ID
|
|
@@ -5258,7 +5258,7 @@ indefinitely.
|
|
|
5258
5258
|
* Delete the autoreply of a mailbox. The mailbox stops sending
|
|
5259
5259
|
automatic replies immediately.
|
|
5260
5260
|
*/
|
|
5261
|
-
"
|
|
5261
|
+
"mail_autoreplies_delete": {
|
|
5262
5262
|
params: {
|
|
5263
5263
|
/**
|
|
5264
5264
|
* Autoreply resource ID
|
|
@@ -5272,7 +5272,7 @@ automatic replies immediately.
|
|
|
5272
5272
|
* Retrieve a paginated list of autoreplies across all mailboxes of a
|
|
5273
5273
|
mail order.
|
|
5274
5274
|
*/
|
|
5275
|
-
"
|
|
5275
|
+
"mail_autoreplies_list": {
|
|
5276
5276
|
params: {
|
|
5277
5277
|
/**
|
|
5278
5278
|
* Order resource ID
|
|
@@ -5296,7 +5296,7 @@ of the domain to the given mailbox. The mailbox address receives a
|
|
|
5296
5296
|
confirmation email and the catch-all becomes active only after it is
|
|
5297
5297
|
confirmed. A domain can have only one catch-all.
|
|
5298
5298
|
*/
|
|
5299
|
-
"
|
|
5299
|
+
"mail_catchalls_create-catch-all": {
|
|
5300
5300
|
params: {
|
|
5301
5301
|
/**
|
|
5302
5302
|
* Mailbox resource ID
|
|
@@ -5310,7 +5310,7 @@ confirmed. A domain can have only one catch-all.
|
|
|
5310
5310
|
* Delete a catch-all. Messages sent to unknown addresses of the domain
|
|
5311
5311
|
are no longer routed to the mailbox.
|
|
5312
5312
|
*/
|
|
5313
|
-
"
|
|
5313
|
+
"mail_catchalls_delete-catch-all": {
|
|
5314
5314
|
params: {
|
|
5315
5315
|
/**
|
|
5316
5316
|
* Catch-all resource ID
|
|
@@ -5324,7 +5324,7 @@ are no longer routed to the mailbox.
|
|
|
5324
5324
|
* Retrieve a paginated list of catch-alls across all mailboxes of a
|
|
5325
5325
|
mail order.
|
|
5326
5326
|
*/
|
|
5327
|
-
"
|
|
5327
|
+
"mail_catchalls_list-catch-alls": {
|
|
5328
5328
|
params: {
|
|
5329
5329
|
/**
|
|
5330
5330
|
* Order resource ID
|
|
@@ -5346,7 +5346,7 @@ mail order.
|
|
|
5346
5346
|
* Resend the confirmation email to the mailbox address of an
|
|
5347
5347
|
unconfirmed catch-all.
|
|
5348
5348
|
*/
|
|
5349
|
-
"
|
|
5349
|
+
"mail_catchalls_resend-catch-all-confirmation": {
|
|
5350
5350
|
params: {
|
|
5351
5351
|
/**
|
|
5352
5352
|
* Catch-all resource ID
|
|
@@ -5361,7 +5361,7 @@ unconfirmed catch-all.
|
|
|
5361
5361
|
The destination receives a confirmation email and forwarding becomes
|
|
5362
5362
|
active only after it is confirmed.
|
|
5363
5363
|
*/
|
|
5364
|
-
"
|
|
5364
|
+
"mail_forwarders_create": {
|
|
5365
5365
|
params: {
|
|
5366
5366
|
/**
|
|
5367
5367
|
* Mailbox resource ID
|
|
@@ -5383,7 +5383,7 @@ active only after it is confirmed.
|
|
|
5383
5383
|
* Delete a forwarder. The mailbox stops forwarding messages to the
|
|
5384
5384
|
destination address immediately.
|
|
5385
5385
|
*/
|
|
5386
|
-
"
|
|
5386
|
+
"mail_forwarders_delete": {
|
|
5387
5387
|
params: {
|
|
5388
5388
|
/**
|
|
5389
5389
|
* Forwarder resource ID
|
|
@@ -5397,7 +5397,7 @@ destination address immediately.
|
|
|
5397
5397
|
* Retrieve a paginated list of forwarders across all mailboxes of a
|
|
5398
5398
|
mail order.
|
|
5399
5399
|
*/
|
|
5400
|
-
"
|
|
5400
|
+
"mail_forwarders_list": {
|
|
5401
5401
|
params: {
|
|
5402
5402
|
/**
|
|
5403
5403
|
* Order resource ID
|
|
@@ -5419,7 +5419,7 @@ mail order.
|
|
|
5419
5419
|
* Resend the confirmation email to the destination address of an
|
|
5420
5420
|
unconfirmed forwarder.
|
|
5421
5421
|
*/
|
|
5422
|
-
"
|
|
5422
|
+
"mail_forwarders_resend-confirmation": {
|
|
5423
5423
|
params: {
|
|
5424
5424
|
/**
|
|
5425
5425
|
* Forwarder resource ID
|
|
@@ -5433,7 +5433,7 @@ unconfirmed forwarder.
|
|
|
5433
5433
|
* Enable or disable keeping a copy of forwarded messages in the
|
|
5434
5434
|
mailbox.
|
|
5435
5435
|
*/
|
|
5436
|
-
"
|
|
5436
|
+
"mail_forwarders_update-keep-copy-setting": {
|
|
5437
5437
|
params: {
|
|
5438
5438
|
/**
|
|
5439
5439
|
* Forwarder resource ID
|
|
@@ -5452,7 +5452,7 @@ mailbox.
|
|
|
5452
5452
|
mail order. Supports filtering by account, date range, protocol,
|
|
5453
5453
|
status, and deletion flag. Results are sorted by timestamp descending.
|
|
5454
5454
|
*/
|
|
5455
|
-
"
|
|
5455
|
+
"mail_logs_list-access": {
|
|
5456
5456
|
params: {
|
|
5457
5457
|
/**
|
|
5458
5458
|
* Order resource ID
|
|
@@ -5503,7 +5503,7 @@ status, and deletion flag. Results are sorted by timestamp descending.
|
|
|
5503
5503
|
actions) for the given mail order. Supports filtering by account,
|
|
5504
5504
|
date range, and status. Results are sorted by timestamp descending.
|
|
5505
5505
|
*/
|
|
5506
|
-
"
|
|
5506
|
+
"mail_logs_list-action": {
|
|
5507
5507
|
params: {
|
|
5508
5508
|
/**
|
|
5509
5509
|
* Order resource ID
|
|
@@ -5547,7 +5547,7 @@ domain attached to the given mail order. Supports filtering by
|
|
|
5547
5547
|
account, date range, status, sender, and recipient. Results are
|
|
5548
5548
|
sorted by timestamp descending.
|
|
5549
5549
|
*/
|
|
5550
|
-
"
|
|
5550
|
+
"mail_logs_list-inbound": {
|
|
5551
5551
|
params: {
|
|
5552
5552
|
/**
|
|
5553
5553
|
* Order resource ID
|
|
@@ -5599,7 +5599,7 @@ for a mailbox in the given mail order. The mailbox email must belong
|
|
|
5599
5599
|
to the order's domain. Supports date range and event type filters.
|
|
5600
5600
|
Results are sorted by timestamp descending.
|
|
5601
5601
|
*/
|
|
5602
|
-
"
|
|
5602
|
+
"mail_logs_list-mailbox-action": {
|
|
5603
5603
|
params: {
|
|
5604
5604
|
/**
|
|
5605
5605
|
* Order resource ID
|
|
@@ -5643,7 +5643,7 @@ attached to the given mail order. Supports filtering by account, date
|
|
|
5643
5643
|
range, status, sender, and recipient. Results are sorted by timestamp
|
|
5644
5644
|
descending.
|
|
5645
5645
|
*/
|
|
5646
|
-
"
|
|
5646
|
+
"mail_logs_list-outbound": {
|
|
5647
5647
|
params: {
|
|
5648
5648
|
/**
|
|
5649
5649
|
* Order resource ID
|
|
@@ -5696,7 +5696,7 @@ Use this endpoint to monitor mailboxes of your mail service, including
|
|
|
5696
5696
|
their status, enabled protocols, attached resource counts, and
|
|
5697
5697
|
periodically synced usage numbers (usage may lag behind live values).
|
|
5698
5698
|
*/
|
|
5699
|
-
"
|
|
5699
|
+
"mail_mailboxes_list": {
|
|
5700
5700
|
params: {
|
|
5701
5701
|
/**
|
|
5702
5702
|
* Order resource ID
|
|
@@ -5726,7 +5726,7 @@ periodically synced usage numbers (usage may lag behind live values).
|
|
|
5726
5726
|
* Create a mailbox under the given mail order. The full email address is
|
|
5727
5727
|
composed from the given local part and the domain of the order.
|
|
5728
5728
|
*/
|
|
5729
|
-
"
|
|
5729
|
+
"mail_mailboxes_create-mailbox": {
|
|
5730
5730
|
params: {
|
|
5731
5731
|
/**
|
|
5732
5732
|
* Order resource ID
|
|
@@ -5748,7 +5748,7 @@ composed from the given local part and the domain of the order.
|
|
|
5748
5748
|
* Delete a mailbox. The mailbox is soft-deleted and stays restorable
|
|
5749
5749
|
for a limited period before it is permanently removed.
|
|
5750
5750
|
*/
|
|
5751
|
-
"
|
|
5751
|
+
"mail_mailboxes_delete-mailbox": {
|
|
5752
5752
|
params: {
|
|
5753
5753
|
/**
|
|
5754
5754
|
* Mailbox resource ID
|
|
@@ -5761,7 +5761,7 @@ for a limited period before it is permanently removed.
|
|
|
5761
5761
|
/**
|
|
5762
5762
|
* Change the password of a mailbox.
|
|
5763
5763
|
*/
|
|
5764
|
-
"
|
|
5764
|
+
"mail_mailboxes_change-mailbox-password": {
|
|
5765
5765
|
params: {
|
|
5766
5766
|
/**
|
|
5767
5767
|
* Mailbox resource ID
|
|
@@ -5781,7 +5781,7 @@ for a limited period before it is permanently removed.
|
|
|
5781
5781
|
Use this endpoint to monitor your mail services, including their status,
|
|
5782
5782
|
plan, attached domain, and expiration details.
|
|
5783
5783
|
*/
|
|
5784
|
-
"
|
|
5784
|
+
"mail_orders_list": {
|
|
5785
5785
|
params: {
|
|
5786
5786
|
/**
|
|
5787
5787
|
* Filter orders by domain name (exact match)
|
|
@@ -5816,7 +5816,7 @@ plan, attached domain, and expiration details.
|
|
|
5816
5816
|
domain-level and mailbox-level quotas, limits, and protocol
|
|
5817
5817
|
availability.
|
|
5818
5818
|
*/
|
|
5819
|
-
"
|
|
5819
|
+
"mail_orders_plan": {
|
|
5820
5820
|
params: {
|
|
5821
5821
|
/**
|
|
5822
5822
|
* Order resource ID
|
|
@@ -5831,7 +5831,7 @@ availability.
|
|
|
5831
5831
|
returned only in this response and is sent as a bearer token with
|
|
5832
5832
|
every delivery.
|
|
5833
5833
|
*/
|
|
5834
|
-
"
|
|
5834
|
+
"mail_webhooks_create": {
|
|
5835
5835
|
params: {
|
|
5836
5836
|
/**
|
|
5837
5837
|
* Mailbox resource ID
|
|
@@ -5866,7 +5866,7 @@ every delivery.
|
|
|
5866
5866
|
order, including delivery outcome, duration, and retry counts.
|
|
5867
5867
|
Supports filtering by mailbox.
|
|
5868
5868
|
*/
|
|
5869
|
-
"
|
|
5869
|
+
"mail_webhooks_list-delivery-logs": {
|
|
5870
5870
|
params: {
|
|
5871
5871
|
/**
|
|
5872
5872
|
* Order resource ID
|
|
@@ -5893,7 +5893,7 @@ Supports filtering by mailbox.
|
|
|
5893
5893
|
included; it is returned only when a webhook is created or its secret
|
|
5894
5894
|
is regenerated.
|
|
5895
5895
|
*/
|
|
5896
|
-
"
|
|
5896
|
+
"mail_webhooks_get": {
|
|
5897
5897
|
params: {
|
|
5898
5898
|
/**
|
|
5899
5899
|
* Webhook ID (returned when the webhook was created)
|
|
@@ -5907,7 +5907,7 @@ is regenerated.
|
|
|
5907
5907
|
* Permanently delete a webhook. This action cannot be undone. After
|
|
5908
5908
|
deletion the URL no longer receives event notifications.
|
|
5909
5909
|
*/
|
|
5910
|
-
"
|
|
5910
|
+
"mail_webhooks_delete": {
|
|
5911
5911
|
params: {
|
|
5912
5912
|
/**
|
|
5913
5913
|
* Webhook ID (returned when the webhook was created)
|
|
@@ -5922,7 +5922,7 @@ deletion the URL no longer receives event notifications.
|
|
|
5922
5922
|
body are changed; omitted fields retain their current values. Pass
|
|
5923
5923
|
`"description": null` to clear the description.
|
|
5924
5924
|
*/
|
|
5925
|
-
"
|
|
5925
|
+
"mail_webhooks_update": {
|
|
5926
5926
|
params: {
|
|
5927
5927
|
/**
|
|
5928
5928
|
* Webhook ID (returned when the webhook was created)
|
|
@@ -5958,7 +5958,7 @@ order. Supports filtering by mailbox and status. The webhook secret
|
|
|
5958
5958
|
is never included; it is returned only when a webhook is created or
|
|
5959
5959
|
its secret is regenerated.
|
|
5960
5960
|
*/
|
|
5961
|
-
"
|
|
5961
|
+
"mail_webhooks_list": {
|
|
5962
5962
|
params: {
|
|
5963
5963
|
/**
|
|
5964
5964
|
* Order resource ID
|
|
@@ -5989,7 +5989,7 @@ its secret is regenerated.
|
|
|
5989
5989
|
immediately invalidated. The new secret is returned only in this
|
|
5990
5990
|
response and is sent as a bearer token with every delivery.
|
|
5991
5991
|
*/
|
|
5992
|
-
"
|
|
5992
|
+
"mail_webhooks_regenerate-secret": {
|
|
5993
5993
|
params: {
|
|
5994
5994
|
/**
|
|
5995
5995
|
* Webhook ID (returned when the webhook was created)
|
|
@@ -6003,7 +6003,7 @@ response and is sent as a bearer token with every delivery.
|
|
|
6003
6003
|
* Send a test delivery to the webhook URL and return the result. Test
|
|
6004
6004
|
requests are rate limited upstream.
|
|
6005
6005
|
*/
|
|
6006
|
-
"
|
|
6006
|
+
"mail_webhooks_test": {
|
|
6007
6007
|
params: {
|
|
6008
6008
|
/**
|
|
6009
6009
|
* Webhook ID (returned when the webhook was created)
|
|
@@ -6019,7 +6019,7 @@ finished it or failed on the way.
|
|
|
6019
6019
|
|
|
6020
6020
|
This describes the automation itself. To see the workflow it runs, use the steps endpoint.
|
|
6021
6021
|
*/
|
|
6022
|
-
"
|
|
6022
|
+
"reach_automations_get": {
|
|
6023
6023
|
params: {
|
|
6024
6024
|
/**
|
|
6025
6025
|
* Profile uuid parameter
|
|
@@ -6041,7 +6041,7 @@ finished it or failed on the way. Those counts describe the contact journey and
|
|
|
6041
6041
|
email engagement metrics - for opens, clicks and unsubscribes use the campaign statistics
|
|
6042
6042
|
endpoint instead.
|
|
6043
6043
|
*/
|
|
6044
|
-
"
|
|
6044
|
+
"reach_automations_list": {
|
|
6045
6045
|
params: {
|
|
6046
6046
|
/**
|
|
6047
6047
|
* Profile uuid parameter
|
|
@@ -6077,7 +6077,7 @@ The steps form a tree rather than a straight line: follow `parent_uuid` to recon
|
|
|
6077
6077
|
branches, and use `step_order` to order the steps that share a parent. An automation with no
|
|
6078
6078
|
steps yet returns an empty list.
|
|
6079
6079
|
*/
|
|
6080
|
-
"
|
|
6080
|
+
"reach_automations_list-steps": {
|
|
6081
6081
|
params: {
|
|
6082
6082
|
/**
|
|
6083
6083
|
* Profile uuid parameter
|
|
@@ -6098,7 +6098,7 @@ progress.
|
|
|
6098
6098
|
This describes how the campaign was set up and how far it has got. For opens, clicks and
|
|
6099
6099
|
unsubscribes use the campaign statistics endpoint.
|
|
6100
6100
|
*/
|
|
6101
|
-
"
|
|
6101
|
+
"reach_campaigns_get": {
|
|
6102
6102
|
params: {
|
|
6103
6103
|
/**
|
|
6104
6104
|
* Profile uuid parameter
|
|
@@ -6120,7 +6120,7 @@ scheduled, sending or sent campaigns, keeping in mind that a fully sent campaign
|
|
|
6120
6120
|
status `publish`. By default only regular campaigns are returned - pass `type` to get the
|
|
6121
6121
|
emails sent by automations or the double opt-in confirmations instead.
|
|
6122
6122
|
*/
|
|
6123
|
-
"
|
|
6123
|
+
"reach_campaigns_list": {
|
|
6124
6124
|
params: {
|
|
6125
6125
|
/**
|
|
6126
6126
|
* Profile uuid parameter
|
|
@@ -6163,7 +6163,7 @@ The campaign is created as a draft, so nothing is sent and no contact is touched
|
|
|
6163
6163
|
audience yet either - targeting and scheduling are not part of this request, the draft is
|
|
6164
6164
|
finished and sent from the Reach interface.
|
|
6165
6165
|
*/
|
|
6166
|
-
"
|
|
6166
|
+
"reach_campaigns_create-draft": {
|
|
6167
6167
|
params: {
|
|
6168
6168
|
/**
|
|
6169
6169
|
* Profile uuid parameter
|
|
@@ -6206,7 +6206,7 @@ matching rates.
|
|
|
6206
6206
|
Every count is unique contacts rather than raw events, so a contact who opens the same email
|
|
6207
6207
|
five times is counted once.
|
|
6208
6208
|
*/
|
|
6209
|
-
"
|
|
6209
|
+
"reach_campaigns_performance": {
|
|
6210
6210
|
params: {
|
|
6211
6211
|
/**
|
|
6212
6212
|
* Profile uuid parameter
|
|
@@ -6229,7 +6229,7 @@ This endpoint permanently removes a contact from the email marketing system.
|
|
|
6229
6229
|
client's default profile and cannot delete contacts of any other profile. Use
|
|
6230
6230
|
`DELETE /api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid}` instead.
|
|
6231
6231
|
*/
|
|
6232
|
-
"
|
|
6232
|
+
"reach_contacts_delete": {
|
|
6233
6233
|
params: {
|
|
6234
6234
|
/**
|
|
6235
6235
|
* UUID of the contact to delete
|
|
@@ -6245,7 +6245,7 @@ client's default profile and cannot delete contacts of any other profile. Use
|
|
|
6245
6245
|
Every value contacts hold for the field is deleted with it, and for the choice types so
|
|
6246
6246
|
are its options. The contacts themselves are not affected.
|
|
6247
6247
|
*/
|
|
6248
|
-
"
|
|
6248
|
+
"reach_contact-fields_delete": {
|
|
6249
6249
|
params: {
|
|
6250
6250
|
/**
|
|
6251
6251
|
* Profile uuid parameter
|
|
@@ -6266,7 +6266,7 @@ Options carrying a uuid are kept and relabelled, options without one are created
|
|
|
6266
6266
|
existing option left out of the list is deleted along with the values contacts hold for
|
|
6267
6267
|
it. The field type and slug cannot be changed.
|
|
6268
6268
|
*/
|
|
6269
|
-
"
|
|
6269
|
+
"reach_contact-fields_update": {
|
|
6270
6270
|
params: {
|
|
6271
6271
|
/**
|
|
6272
6272
|
* Profile uuid parameter
|
|
@@ -6295,7 +6295,7 @@ Custom fields let you store your own attributes on contacts. The returned uuids
|
|
|
6295
6295
|
you pass to the contact update endpoint to set values, and choice fields also list the
|
|
6296
6296
|
options available to pick from.
|
|
6297
6297
|
*/
|
|
6298
|
-
"
|
|
6298
|
+
"reach_contact-fields_list": {
|
|
6299
6299
|
params: {
|
|
6300
6300
|
/**
|
|
6301
6301
|
* Profile uuid parameter
|
|
@@ -6311,7 +6311,7 @@ options available to pick from.
|
|
|
6311
6311
|
The `slug` is derived from the label and, like the field type, cannot be changed later.
|
|
6312
6312
|
Use the returned uuid to set values on contacts.
|
|
6313
6313
|
*/
|
|
6314
|
-
"
|
|
6314
|
+
"reach_contact-fields_create": {
|
|
6315
6315
|
params: {
|
|
6316
6316
|
/**
|
|
6317
6317
|
* Profile uuid parameter
|
|
@@ -6338,7 +6338,7 @@ Use the returned uuid to set values on contacts.
|
|
|
6338
6338
|
|
|
6339
6339
|
This endpoint returns a list of contact groups that can be used to organize contacts.
|
|
6340
6340
|
*/
|
|
6341
|
-
"
|
|
6341
|
+
"reach_contacts_list-groups": {
|
|
6342
6342
|
params: {
|
|
6343
6343
|
|
|
6344
6344
|
};
|
|
@@ -6356,7 +6356,7 @@ client's default profile and cannot list contacts of any other profile. Use
|
|
|
6356
6356
|
`GET /api/reach/v1/profiles/{profileUuid}/contacts` instead, which also replaces the
|
|
6357
6357
|
group filter with a tag filter.
|
|
6358
6358
|
*/
|
|
6359
|
-
"
|
|
6359
|
+
"reach_contacts_list": {
|
|
6360
6360
|
params: {
|
|
6361
6361
|
/**
|
|
6362
6362
|
* Filter contacts by group UUID
|
|
@@ -6382,7 +6382,7 @@ This endpoint allows you to create a new contact with basic information like nam
|
|
|
6382
6382
|
If double opt-in is enabled,
|
|
6383
6383
|
the contact will be created with a pending status and a confirmation email will be sent.
|
|
6384
6384
|
*/
|
|
6385
|
-
"
|
|
6385
|
+
"reach_contacts_create": {
|
|
6386
6386
|
params: {
|
|
6387
6387
|
/**
|
|
6388
6388
|
* email parameter
|
|
@@ -6418,7 +6418,7 @@ the contact will be created with a pending status and a confirmation email will
|
|
|
6418
6418
|
Alongside the contact's own attributes this returns the tags assigned to it and the
|
|
6419
6419
|
values it holds for the profile's custom contact fields.
|
|
6420
6420
|
*/
|
|
6421
|
-
"
|
|
6421
|
+
"reach_contacts_get": {
|
|
6422
6422
|
params: {
|
|
6423
6423
|
/**
|
|
6424
6424
|
* Profile uuid parameter
|
|
@@ -6437,7 +6437,7 @@ values it holds for the profile's custom contact fields.
|
|
|
6437
6437
|
|
|
6438
6438
|
The contact is removed together with its custom field values and tag assignments.
|
|
6439
6439
|
*/
|
|
6440
|
-
"
|
|
6440
|
+
"reach_contacts_delete-profile": {
|
|
6441
6441
|
params: {
|
|
6442
6442
|
/**
|
|
6443
6443
|
* Profile uuid parameter
|
|
@@ -6460,7 +6460,7 @@ to change a single attribute. Sending a property as `null` clears it.
|
|
|
6460
6460
|
The response carries the contact's core attributes. Read back its tags, custom field
|
|
6461
6461
|
values, source and note with `GET /api/reach/v1/profiles/{profileUuid}/contacts/{contactUuid}`.
|
|
6462
6462
|
*/
|
|
6463
|
-
"
|
|
6463
|
+
"reach_contacts_update": {
|
|
6464
6464
|
params: {
|
|
6465
6465
|
/**
|
|
6466
6466
|
* Profile uuid parameter
|
|
@@ -6510,7 +6510,7 @@ accepted rather than finished. Contacts whose email already exists in the profil
|
|
|
6510
6510
|
left as they are. If double opt-in is enabled, new contacts start off pending and are
|
|
6511
6511
|
sent a confirmation email.
|
|
6512
6512
|
*/
|
|
6513
|
-
"
|
|
6513
|
+
"reach_contacts_create-in-bulk": {
|
|
6514
6514
|
params: {
|
|
6515
6515
|
/**
|
|
6516
6516
|
* Profile uuid parameter
|
|
@@ -6539,7 +6539,7 @@ Contacts can be filtered by subscription status, by tag, and by an email search
|
|
|
6539
6539
|
The `meta.total` field of the response is the number of contacts matching the filters,
|
|
6540
6540
|
so calling this endpoint without filters gives the profile's total contact count.
|
|
6541
6541
|
*/
|
|
6542
|
-
"
|
|
6542
|
+
"reach_contacts_list-profile": {
|
|
6543
6543
|
params: {
|
|
6544
6544
|
/**
|
|
6545
6545
|
* Profile uuid parameter
|
|
@@ -6577,7 +6577,7 @@ This endpoint allows you to create a new contact with basic information like nam
|
|
|
6577
6577
|
If double opt-in is enabled, the contact will be created with a pending status
|
|
6578
6578
|
and a confirmation email will be sent.
|
|
6579
6579
|
*/
|
|
6580
|
-
"
|
|
6580
|
+
"reach_contacts_create-bulk": {
|
|
6581
6581
|
params: {
|
|
6582
6582
|
/**
|
|
6583
6583
|
* Profile uuid parameter
|
|
@@ -6620,7 +6620,7 @@ This endpoint returns a list of contact segments that can be used to organize co
|
|
|
6620
6620
|
the client's default profile and cannot list the segments of any other profile. Use
|
|
6621
6621
|
`GET /api/reach/v1/profiles/{profileUuid}/segmentation/segments` instead.
|
|
6622
6622
|
*/
|
|
6623
|
-
"
|
|
6623
|
+
"reach_segments_list": {
|
|
6624
6624
|
params: {
|
|
6625
6625
|
|
|
6626
6626
|
};
|
|
@@ -6637,7 +6637,7 @@ The segment can be configured with specific criteria like email, name, subscript
|
|
|
6637
6637
|
the client's default profile and cannot create segments in any other profile. Use
|
|
6638
6638
|
`POST /api/reach/v1/profiles/{profileUuid}/segmentation/segments` instead.
|
|
6639
6639
|
*/
|
|
6640
|
-
"
|
|
6640
|
+
"reach_segments_create": {
|
|
6641
6641
|
params: {
|
|
6642
6642
|
/**
|
|
6643
6643
|
* name parameter
|
|
@@ -6660,7 +6660,7 @@ the client's default profile and cannot create segments in any other profile. Us
|
|
|
6660
6660
|
|
|
6661
6661
|
Cheaper than paging through the segment contacts endpoint when only the size is needed.
|
|
6662
6662
|
*/
|
|
6663
|
-
"
|
|
6663
|
+
"reach_segments_count-profile-contacts": {
|
|
6664
6664
|
params: {
|
|
6665
6665
|
/**
|
|
6666
6666
|
* Profile uuid parameter
|
|
@@ -6680,7 +6680,7 @@ Cheaper than paging through the segment contacts endpoint when only the size is
|
|
|
6680
6680
|
This endpoint allows you to fetch and filter contacts that belong to a particular segment,
|
|
6681
6681
|
identified by its UUID, scoped to a specific profile.
|
|
6682
6682
|
*/
|
|
6683
|
-
"
|
|
6683
|
+
"reach_segments_list-profile-contacts": {
|
|
6684
6684
|
params: {
|
|
6685
6685
|
/**
|
|
6686
6686
|
* Profile uuid parameter
|
|
@@ -6708,7 +6708,7 @@ identified by its UUID, scoped to a specific profile.
|
|
|
6708
6708
|
To retrieve the contacts currently matching those conditions, use the segment contacts
|
|
6709
6709
|
endpoint instead.
|
|
6710
6710
|
*/
|
|
6711
|
-
"
|
|
6711
|
+
"reach_segments_profile": {
|
|
6712
6712
|
params: {
|
|
6713
6713
|
/**
|
|
6714
6714
|
* Profile uuid parameter
|
|
@@ -6729,7 +6729,7 @@ endpoint instead.
|
|
|
6729
6729
|
supply them and they replace the existing set entirely rather than being merged into it.
|
|
6730
6730
|
Contacts are never modified, but which of them match the segment can change immediately.
|
|
6731
6731
|
*/
|
|
6732
|
-
"
|
|
6732
|
+
"reach_segments_update-profile": {
|
|
6733
6733
|
params: {
|
|
6734
6734
|
/**
|
|
6735
6735
|
* Profile uuid parameter
|
|
@@ -6760,7 +6760,7 @@ Contacts are never modified, but which of them match the segment can change imme
|
|
|
6760
6760
|
|
|
6761
6761
|
Only the segment definition is removed. The contacts that matched it are left untouched.
|
|
6762
6762
|
*/
|
|
6763
|
-
"
|
|
6763
|
+
"reach_segments_delete-profile": {
|
|
6764
6764
|
params: {
|
|
6765
6765
|
/**
|
|
6766
6766
|
* Profile uuid parameter
|
|
@@ -6784,7 +6784,7 @@ its 20 most recently published campaigns, so the valid attributes cannot be hard
|
|
|
6784
6784
|
it before creating or updating a segment to discover the valid `attribute`, `operator` and
|
|
6785
6785
|
`value` combinations.
|
|
6786
6786
|
*/
|
|
6787
|
-
"
|
|
6787
|
+
"reach_segments_list-filter-attributes": {
|
|
6788
6788
|
params: {
|
|
6789
6789
|
/**
|
|
6790
6790
|
* Profile uuid parameter
|
|
@@ -6804,7 +6804,7 @@ and no contact is modified.
|
|
|
6804
6804
|
Call the segment filter attributes endpoint first to discover the valid `attribute`,
|
|
6805
6805
|
`operator` and `value` combinations.
|
|
6806
6806
|
*/
|
|
6807
|
-
"
|
|
6807
|
+
"reach_segments_preview-contacts-matching-conditions": {
|
|
6808
6808
|
params: {
|
|
6809
6809
|
/**
|
|
6810
6810
|
* Profile uuid parameter
|
|
@@ -6849,7 +6849,7 @@ Each entry carries the number of contacts currently matching it, which is recalc
|
|
|
6849
6849
|
read rather than stored. Use `count_type` to count either every matching contact or only
|
|
6850
6850
|
the subscribed ones.
|
|
6851
6851
|
*/
|
|
6852
|
-
"
|
|
6852
|
+
"reach_segments_list-profile": {
|
|
6853
6853
|
params: {
|
|
6854
6854
|
/**
|
|
6855
6855
|
* Profile uuid parameter
|
|
@@ -6877,7 +6877,7 @@ the subscribed ones.
|
|
|
6877
6877
|
A segment is a saved set of conditions rather than a fixed list, so its membership changes
|
|
6878
6878
|
as contacts change. Creating one does not modify any contact.
|
|
6879
6879
|
*/
|
|
6880
|
-
"
|
|
6880
|
+
"reach_segments_create-profile": {
|
|
6881
6881
|
params: {
|
|
6882
6882
|
/**
|
|
6883
6883
|
* Profile uuid parameter
|
|
@@ -6909,7 +6909,7 @@ identified by its UUID.
|
|
|
6909
6909
|
the client's default profile and cannot read segments of any other profile. Use
|
|
6910
6910
|
`GET /api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}/contacts` instead.
|
|
6911
6911
|
*/
|
|
6912
|
-
"
|
|
6912
|
+
"reach_segments_list-contacts": {
|
|
6913
6913
|
params: {
|
|
6914
6914
|
/**
|
|
6915
6915
|
* Segment uuid parameter
|
|
@@ -6937,7 +6937,7 @@ Segments are used to organize and group contacts based on specific criteria.
|
|
|
6937
6937
|
the client's default profile and cannot read segments of any other profile. Use
|
|
6938
6938
|
`GET /api/reach/v1/profiles/{profileUuid}/segmentation/segments/{segmentUuid}` instead.
|
|
6939
6939
|
*/
|
|
6940
|
-
"
|
|
6940
|
+
"reach_segments_get": {
|
|
6941
6941
|
params: {
|
|
6942
6942
|
/**
|
|
6943
6943
|
* Segment uuid parameter
|
|
@@ -6953,7 +6953,7 @@ the client's default profile and cannot read segments of any other profile. Use
|
|
|
6953
6953
|
Unlike the bulk endpoint this is applied immediately rather than queued. Assigning a tag
|
|
6954
6954
|
the contact already carries succeeds without duplicating it.
|
|
6955
6955
|
*/
|
|
6956
|
-
"
|
|
6956
|
+
"reach_tags_assign-contact-to": {
|
|
6957
6957
|
params: {
|
|
6958
6958
|
/**
|
|
6959
6959
|
* Profile uuid parameter
|
|
@@ -6977,7 +6977,7 @@ the contact already carries succeeds without duplicating it.
|
|
|
6977
6977
|
Unlike the bulk endpoint this is applied immediately rather than queued. Neither the tag
|
|
6978
6978
|
nor the contact is deleted.
|
|
6979
6979
|
*/
|
|
6980
|
-
"
|
|
6980
|
+
"reach_tags_remove-contact-from": {
|
|
6981
6981
|
params: {
|
|
6982
6982
|
/**
|
|
6983
6983
|
* Profile uuid parameter
|
|
@@ -7002,7 +7002,7 @@ Pass `contact_uuids` to target specific contacts, or `all_contacts` to target ev
|
|
|
7002
7002
|
in the profile. The work is queued, so a success response means it was accepted rather than
|
|
7003
7003
|
finished. Contacts that already carry the tag are left alone.
|
|
7004
7004
|
*/
|
|
7005
|
-
"
|
|
7005
|
+
"reach_tags_assign-contacts-to": {
|
|
7006
7006
|
params: {
|
|
7007
7007
|
/**
|
|
7008
7008
|
* Profile uuid parameter
|
|
@@ -7031,7 +7031,7 @@ Pass `contact_uuids` to target specific contacts, or `all_contacts` to target ev
|
|
|
7031
7031
|
in the profile. The work is queued, so a success response means it was accepted rather than
|
|
7032
7032
|
finished. The tag itself and the contacts are not deleted.
|
|
7033
7033
|
*/
|
|
7034
|
-
"
|
|
7034
|
+
"reach_tags_remove-contacts-from": {
|
|
7035
7035
|
params: {
|
|
7036
7036
|
/**
|
|
7037
7037
|
* Profile uuid parameter
|
|
@@ -7051,7 +7051,7 @@ finished. The tag itself and the contacts are not deleted.
|
|
|
7051
7051
|
The contacts themselves are not deleted. This is idempotent: deleting a tag that does not
|
|
7052
7052
|
exist in the profile still succeeds.
|
|
7053
7053
|
*/
|
|
7054
|
-
"
|
|
7054
|
+
"reach_tags_delete": {
|
|
7055
7055
|
params: {
|
|
7056
7056
|
/**
|
|
7057
7057
|
* Profile uuid parameter
|
|
@@ -7071,7 +7071,7 @@ exist in the profile still succeeds.
|
|
|
7071
7071
|
The contacts assigned to the tag are unaffected. Names are unique within a profile, so
|
|
7072
7072
|
renaming a tag to a name that is already taken is rejected.
|
|
7073
7073
|
*/
|
|
7074
|
-
"
|
|
7074
|
+
"reach_tags_rename": {
|
|
7075
7075
|
params: {
|
|
7076
7076
|
/**
|
|
7077
7077
|
* Profile uuid parameter
|
|
@@ -7095,7 +7095,7 @@ renaming a tag to a name that is already taken is rejected.
|
|
|
7095
7095
|
Tags are the way contacts are grouped in Reach, and can be used to filter the contact
|
|
7096
7096
|
list or to build segments.
|
|
7097
7097
|
*/
|
|
7098
|
-
"
|
|
7098
|
+
"reach_tags_list-profile": {
|
|
7099
7099
|
params: {
|
|
7100
7100
|
/**
|
|
7101
7101
|
* Profile uuid parameter
|
|
@@ -7112,7 +7112,7 @@ Names that already exist in the profile are not duplicated: the existing tag is
|
|
|
7112
7112
|
instead, so the call is safe to repeat. Every tag in the request is returned, whether it
|
|
7113
7113
|
was created now or already existed.
|
|
7114
7114
|
*/
|
|
7115
|
-
"
|
|
7115
|
+
"reach_tags_create-or-find": {
|
|
7116
7116
|
params: {
|
|
7117
7117
|
/**
|
|
7118
7118
|
* Profile uuid parameter
|
|
@@ -7133,7 +7133,7 @@ it captures.
|
|
|
7133
7133
|
There is no ready-made embed snippet in the response - either serve the template HTML yourself
|
|
7134
7134
|
or build your own embed around the form uuid.
|
|
7135
7135
|
*/
|
|
7136
|
-
"
|
|
7136
|
+
"reach_forms_get": {
|
|
7137
7137
|
params: {
|
|
7138
7138
|
/**
|
|
7139
7139
|
* Profile uuid parameter
|
|
@@ -7154,7 +7154,7 @@ A form that has already captured submissions cannot be deleted, so that the cont
|
|
|
7154
7154
|
are never silently discarded - pause the form instead to stop it collecting new ones. Views alone
|
|
7155
7155
|
do not block deletion.
|
|
7156
7156
|
*/
|
|
7157
|
-
"
|
|
7157
|
+
"reach_forms_delete": {
|
|
7158
7158
|
params: {
|
|
7159
7159
|
/**
|
|
7160
7160
|
* Profile uuid parameter
|
|
@@ -7174,7 +7174,7 @@ do not block deletion.
|
|
|
7174
7174
|
Each form carries a reference to the template that renders it. Get the form details for a
|
|
7175
7175
|
directly usable template URL and for the tags the form puts on the contacts it captures.
|
|
7176
7176
|
*/
|
|
7177
|
-
"
|
|
7177
|
+
"reach_forms_list": {
|
|
7178
7178
|
params: {
|
|
7179
7179
|
/**
|
|
7180
7180
|
* Profile uuid parameter
|
|
@@ -7198,7 +7198,7 @@ directly usable template URL and for the tags the form puts on the contacts it c
|
|
|
7198
7198
|
This endpoint reports the state of MX, SPF, DKIM and DMARC records, including the
|
|
7199
7199
|
actual records found and the suggested records required for correct email delivery.
|
|
7200
7200
|
*/
|
|
7201
|
-
"
|
|
7201
|
+
"reach_profiles_domain-dns-status": {
|
|
7202
7202
|
params: {
|
|
7203
7203
|
/**
|
|
7204
7204
|
* Profile uuid parameter
|
|
@@ -7217,7 +7217,7 @@ check that precondition before building one. A profile with no domain connected
|
|
|
7217
7217
|
same shape with every field set to `null`. For the individual MX, SPF, DKIM and DMARC records
|
|
7218
7218
|
behind the status, use the DNS status endpoint.
|
|
7219
7219
|
*/
|
|
7220
|
-
"
|
|
7220
|
+
"reach_profiles_connected-sending-domain": {
|
|
7221
7221
|
params: {
|
|
7222
7222
|
/**
|
|
7223
7223
|
* Profile uuid parameter
|
|
@@ -7237,7 +7237,7 @@ For remaining emails, recipients and AI credits use the limits endpoint instead.
|
|
|
7237
7237
|
Worth checking before building something that cannot be activated afterwards, such as an
|
|
7238
7238
|
automation on a plan without automation activation.
|
|
7239
7239
|
*/
|
|
7240
|
-
"
|
|
7240
|
+
"reach_profiles_list-plan-feature-access": {
|
|
7241
7241
|
params: {
|
|
7242
7242
|
/**
|
|
7243
7243
|
* Profile uuid parameter
|
|
@@ -7256,7 +7256,7 @@ subscription started. And usage is tracked per order, so every profile on the sa
|
|
|
7256
7256
|
one pool and reports the same numbers here. Only the current period is available, past usage is
|
|
7257
7257
|
not kept.
|
|
7258
7258
|
*/
|
|
7259
|
-
"
|
|
7259
|
+
"reach_profiles_remaining-plan-limits": {
|
|
7260
7260
|
params: {
|
|
7261
7261
|
/**
|
|
7262
7262
|
* Profile uuid parameter
|
|
@@ -7269,7 +7269,7 @@ not kept.
|
|
|
7269
7269
|
/**
|
|
7270
7270
|
* This endpoint returns all profiles available to the client, including their basic information.
|
|
7271
7271
|
*/
|
|
7272
|
-
"
|
|
7272
|
+
"reach_profiles_list": {
|
|
7273
7273
|
params: {
|
|
7274
7274
|
|
|
7275
7275
|
};
|
|
@@ -7283,7 +7283,7 @@ Templates are the reusable email bodies a campaign is built from. The list is no
|
|
|
7283
7283
|
and only the metadata is returned - the template content itself is not exposed. Use the
|
|
7284
7284
|
`uuid` of a template as the `template_uuid` when creating a campaign.
|
|
7285
7285
|
*/
|
|
7286
|
-
"
|
|
7286
|
+
"reach_templates_list-email": {
|
|
7287
7287
|
params: {
|
|
7288
7288
|
/**
|
|
7289
7289
|
* Profile uuid parameter
|
|
@@ -7300,7 +7300,7 @@ The template holds the HTML body a campaign reuses, so it can be created before
|
|
|
7300
7300
|
campaign exists. Only the template metadata comes back - keep the returned `uuid` to
|
|
7301
7301
|
reference it as the `template_uuid` of a campaign.
|
|
7302
7302
|
*/
|
|
7303
|
-
"
|
|
7303
|
+
"reach_templates_create-email": {
|
|
7304
7304
|
params: {
|
|
7305
7305
|
/**
|
|
7306
7306
|
* Profile uuid parameter
|
|
@@ -7325,7 +7325,7 @@ the markup self-contained.
|
|
|
7325
7325
|
|
|
7326
7326
|
Use this endpoint to view location options before deploying VPS instances.
|
|
7327
7327
|
*/
|
|
7328
|
-
"
|
|
7328
|
+
"vps_data-centers_list": {
|
|
7329
7329
|
params: {
|
|
7330
7330
|
|
|
7331
7331
|
};
|
|
@@ -7340,7 +7340,7 @@ their current status, port mappings, and runtime configuration.
|
|
|
7340
7340
|
|
|
7341
7341
|
Use this to monitor the health and state of all services within your Docker Compose project.
|
|
7342
7342
|
*/
|
|
7343
|
-
"
|
|
7343
|
+
"vps_docker_containers": {
|
|
7344
7344
|
params: {
|
|
7345
7345
|
/**
|
|
7346
7346
|
* Virtual Machine ID
|
|
@@ -7362,7 +7362,7 @@ This endpoint provides the full configuration and state details of a specific Do
|
|
|
7362
7362
|
|
|
7363
7363
|
Use this to inspect project settings, review the compose file, or check the overall project health.
|
|
7364
7364
|
*/
|
|
7365
|
-
"
|
|
7365
|
+
"vps_docker_get": {
|
|
7366
7366
|
params: {
|
|
7367
7367
|
/**
|
|
7368
7368
|
* Virtual Machine ID
|
|
@@ -7384,7 +7384,7 @@ This operation is irreversible and will delete all project data.
|
|
|
7384
7384
|
|
|
7385
7385
|
Use this when you want to permanently remove a project and free up system resources.
|
|
7386
7386
|
*/
|
|
7387
|
-
"
|
|
7387
|
+
"vps_docker_delete": {
|
|
7388
7388
|
params: {
|
|
7389
7389
|
/**
|
|
7390
7390
|
* Virtual Machine ID
|
|
@@ -7409,7 +7409,7 @@ stats included, use the `Get project containers` endpoint.
|
|
|
7409
7409
|
|
|
7410
7410
|
Use this to get an overview of all Docker projects on your VPS instance.
|
|
7411
7411
|
*/
|
|
7412
|
-
"
|
|
7412
|
+
"vps_docker_list": {
|
|
7413
7413
|
params: {
|
|
7414
7414
|
/**
|
|
7415
7415
|
* Virtual Machine ID
|
|
@@ -7429,7 +7429,7 @@ file contents.
|
|
|
7429
7429
|
|
|
7430
7430
|
If project with the same name already exists, existing project will be replaced.
|
|
7431
7431
|
*/
|
|
7432
|
-
"
|
|
7432
|
+
"vps_docker_create": {
|
|
7433
7433
|
params: {
|
|
7434
7434
|
/**
|
|
7435
7435
|
* Virtual Machine ID
|
|
@@ -7460,7 +7460,7 @@ The response contains the last 300 log entries across all services.
|
|
|
7460
7460
|
Use this for debugging, monitoring application behavior, and
|
|
7461
7461
|
troubleshooting issues across your entire project stack.
|
|
7462
7462
|
*/
|
|
7463
|
-
"
|
|
7463
|
+
"vps_docker_logs": {
|
|
7464
7464
|
params: {
|
|
7465
7465
|
/**
|
|
7466
7466
|
* Virtual Machine ID
|
|
@@ -7482,7 +7482,7 @@ This operation preserves data volumes and network configurations while refreshin
|
|
|
7482
7482
|
|
|
7483
7483
|
Use this to apply configuration changes or recover from service failures.
|
|
7484
7484
|
*/
|
|
7485
|
-
"
|
|
7485
|
+
"vps_docker_restart": {
|
|
7486
7486
|
params: {
|
|
7487
7487
|
/**
|
|
7488
7488
|
* Virtual Machine ID
|
|
@@ -7503,7 +7503,7 @@ This operation brings up containers in the correct dependency order as defined i
|
|
|
7503
7503
|
|
|
7504
7504
|
Use this to resume a project that was previously stopped or to start services after a system reboot.
|
|
7505
7505
|
*/
|
|
7506
|
-
"
|
|
7506
|
+
"vps_docker_start": {
|
|
7507
7507
|
params: {
|
|
7508
7508
|
/**
|
|
7509
7509
|
* Virtual Machine ID
|
|
@@ -7525,7 +7525,7 @@ This operation gracefully shuts down containers in reverse dependency order.
|
|
|
7525
7525
|
|
|
7526
7526
|
Use this to temporarily halt a project without removing data or configurations.
|
|
7527
7527
|
*/
|
|
7528
|
-
"
|
|
7528
|
+
"vps_docker_stop": {
|
|
7529
7529
|
params: {
|
|
7530
7530
|
/**
|
|
7531
7531
|
* Virtual Machine ID
|
|
@@ -7548,7 +7548,7 @@ This operation preserves data volumes while applying changes from the compose fi
|
|
|
7548
7548
|
Use this to deploy application updates, apply configuration changes, or
|
|
7549
7549
|
refresh container images to their latest versions.
|
|
7550
7550
|
*/
|
|
7551
|
-
"
|
|
7551
|
+
"vps_docker_update": {
|
|
7552
7552
|
params: {
|
|
7553
7553
|
/**
|
|
7554
7554
|
* Virtual Machine ID
|
|
@@ -7569,7 +7569,7 @@ Only one firewall can be active for a virtual machine at a time.
|
|
|
7569
7569
|
|
|
7570
7570
|
Use this endpoint to apply firewall rules to VPS instances.
|
|
7571
7571
|
*/
|
|
7572
|
-
"
|
|
7572
|
+
"vps_firewall_activate": {
|
|
7573
7573
|
params: {
|
|
7574
7574
|
/**
|
|
7575
7575
|
* Firewall ID
|
|
@@ -7588,7 +7588,7 @@ Use this endpoint to apply firewall rules to VPS instances.
|
|
|
7588
7588
|
|
|
7589
7589
|
Use this endpoint to remove firewall protection from VPS instances.
|
|
7590
7590
|
*/
|
|
7591
|
-
"
|
|
7591
|
+
"vps_firewall_deactivate": {
|
|
7592
7592
|
params: {
|
|
7593
7593
|
/**
|
|
7594
7594
|
* Firewall ID
|
|
@@ -7607,7 +7607,7 @@ Use this endpoint to remove firewall protection from VPS instances.
|
|
|
7607
7607
|
|
|
7608
7608
|
Use this endpoint to view specific firewall configuration and rules.
|
|
7609
7609
|
*/
|
|
7610
|
-
"
|
|
7610
|
+
"vps_firewall_get": {
|
|
7611
7611
|
params: {
|
|
7612
7612
|
/**
|
|
7613
7613
|
* Firewall ID
|
|
@@ -7624,7 +7624,7 @@ Any virtual machine that has this firewall activated will automatically have it
|
|
|
7624
7624
|
|
|
7625
7625
|
Use this endpoint to remove unused firewall configurations.
|
|
7626
7626
|
*/
|
|
7627
|
-
"
|
|
7627
|
+
"vps_firewall_delete": {
|
|
7628
7628
|
params: {
|
|
7629
7629
|
/**
|
|
7630
7630
|
* Firewall ID
|
|
@@ -7639,7 +7639,7 @@ Use this endpoint to remove unused firewall configurations.
|
|
|
7639
7639
|
|
|
7640
7640
|
Use this endpoint to view existing firewall configurations.
|
|
7641
7641
|
*/
|
|
7642
|
-
"
|
|
7642
|
+
"vps_firewall_list": {
|
|
7643
7643
|
params: {
|
|
7644
7644
|
/**
|
|
7645
7645
|
* Page number
|
|
@@ -7654,7 +7654,7 @@ Use this endpoint to view existing firewall configurations.
|
|
|
7654
7654
|
|
|
7655
7655
|
Use this endpoint to set up new firewall configurations for VPS security.
|
|
7656
7656
|
*/
|
|
7657
|
-
"
|
|
7657
|
+
"vps_firewall_create": {
|
|
7658
7658
|
params: {
|
|
7659
7659
|
/**
|
|
7660
7660
|
* name parameter
|
|
@@ -7672,7 +7672,7 @@ and will have to be synced again manually.
|
|
|
7672
7672
|
|
|
7673
7673
|
Use this endpoint to modify existing firewall rules.
|
|
7674
7674
|
*/
|
|
7675
|
-
"
|
|
7675
|
+
"vps_firewall_update-rule": {
|
|
7676
7676
|
params: {
|
|
7677
7677
|
/**
|
|
7678
7678
|
* Firewall ID
|
|
@@ -7710,7 +7710,7 @@ and will have to be synced again manually.
|
|
|
7710
7710
|
|
|
7711
7711
|
Use this endpoint to remove specific firewall rules.
|
|
7712
7712
|
*/
|
|
7713
|
-
"
|
|
7713
|
+
"vps_firewall_delete-rule": {
|
|
7714
7714
|
params: {
|
|
7715
7715
|
/**
|
|
7716
7716
|
* Firewall ID
|
|
@@ -7731,7 +7731,7 @@ in a single atomic operation, instead of creating or deleting rules one by one.
|
|
|
7731
7731
|
Any virtual machine using this firewall group will need to be synchronized after replacing rules;
|
|
7732
7732
|
pass the "sync" parameter to trigger synchronization immediately.
|
|
7733
7733
|
*/
|
|
7734
|
-
"
|
|
7734
|
+
"vps_firewall_replace-all-rules-in-group": {
|
|
7735
7735
|
params: {
|
|
7736
7736
|
/**
|
|
7737
7737
|
* Firewall ID
|
|
@@ -7760,7 +7760,7 @@ and will have to be synced again manually.
|
|
|
7760
7760
|
|
|
7761
7761
|
Use this endpoint to add new security rules to firewalls.
|
|
7762
7762
|
*/
|
|
7763
|
-
"
|
|
7763
|
+
"vps_firewall_create-rule": {
|
|
7764
7764
|
params: {
|
|
7765
7765
|
/**
|
|
7766
7766
|
* Firewall ID
|
|
@@ -7793,7 +7793,7 @@ Firewall can lose sync with a virtual machine if the firewall has new rules adde
|
|
|
7793
7793
|
|
|
7794
7794
|
Use this endpoint to apply updated firewall rules to all VPS instances assigned to the firewall.
|
|
7795
7795
|
*/
|
|
7796
|
-
"
|
|
7796
|
+
"vps_firewall_sync-to-all-assigned-v-ms": {
|
|
7797
7797
|
params: {
|
|
7798
7798
|
/**
|
|
7799
7799
|
* Firewall ID
|
|
@@ -7813,7 +7813,7 @@ Firewall can lose sync with virtual machine if the firewall has new rules added,
|
|
|
7813
7813
|
|
|
7814
7814
|
Use this endpoint to apply updated firewall rules to VPS instances.
|
|
7815
7815
|
*/
|
|
7816
|
-
"
|
|
7816
|
+
"vps_firewall_sync": {
|
|
7817
7817
|
params: {
|
|
7818
7818
|
/**
|
|
7819
7819
|
* Firewall ID
|
|
@@ -7832,7 +7832,7 @@ Use this endpoint to apply updated firewall rules to VPS instances.
|
|
|
7832
7832
|
|
|
7833
7833
|
Use this endpoint to view specific automation script details.
|
|
7834
7834
|
*/
|
|
7835
|
-
"
|
|
7835
|
+
"vps_post-install-scripts_get": {
|
|
7836
7836
|
params: {
|
|
7837
7837
|
/**
|
|
7838
7838
|
* Post-install script ID
|
|
@@ -7847,7 +7847,7 @@ Use this endpoint to view specific automation script details.
|
|
|
7847
7847
|
|
|
7848
7848
|
Use this endpoint to modify existing automation scripts.
|
|
7849
7849
|
*/
|
|
7850
|
-
"
|
|
7850
|
+
"vps_post-install-scripts_update": {
|
|
7851
7851
|
params: {
|
|
7852
7852
|
/**
|
|
7853
7853
|
* Post-install script ID
|
|
@@ -7870,7 +7870,7 @@ Use this endpoint to modify existing automation scripts.
|
|
|
7870
7870
|
|
|
7871
7871
|
Use this endpoint to remove unused automation scripts.
|
|
7872
7872
|
*/
|
|
7873
|
-
"
|
|
7873
|
+
"vps_post-install-scripts_delete": {
|
|
7874
7874
|
params: {
|
|
7875
7875
|
/**
|
|
7876
7876
|
* Post-install script ID
|
|
@@ -7885,7 +7885,7 @@ Use this endpoint to remove unused automation scripts.
|
|
|
7885
7885
|
|
|
7886
7886
|
Use this endpoint to view available automation scripts for VPS deployment.
|
|
7887
7887
|
*/
|
|
7888
|
-
"
|
|
7888
|
+
"vps_post-install-scripts_list": {
|
|
7889
7889
|
params: {
|
|
7890
7890
|
/**
|
|
7891
7891
|
* Page number
|
|
@@ -7904,7 +7904,7 @@ The output of the script will be redirected to `/post_install.log`. Maximum scri
|
|
|
7904
7904
|
|
|
7905
7905
|
Use this endpoint to create automation scripts for VPS setup tasks.
|
|
7906
7906
|
*/
|
|
7907
|
-
"
|
|
7907
|
+
"vps_post-install-scripts_create": {
|
|
7908
7908
|
params: {
|
|
7909
7909
|
/**
|
|
7910
7910
|
* Name of the script
|
|
@@ -7925,7 +7925,7 @@ Multiple keys can be attached to a single virtual machine.
|
|
|
7925
7925
|
|
|
7926
7926
|
Use this endpoint to enable SSH key authentication for VPS instances.
|
|
7927
7927
|
*/
|
|
7928
|
-
"
|
|
7928
|
+
"vps_public-keys_attach": {
|
|
7929
7929
|
params: {
|
|
7930
7930
|
/**
|
|
7931
7931
|
* Virtual Machine ID
|
|
@@ -7946,7 +7946,7 @@ Use this endpoint to enable SSH key authentication for VPS instances.
|
|
|
7946
7946
|
|
|
7947
7947
|
Use this endpoint to remove unused SSH keys from account.
|
|
7948
7948
|
*/
|
|
7949
|
-
"
|
|
7949
|
+
"vps_public-keys_delete": {
|
|
7950
7950
|
params: {
|
|
7951
7951
|
/**
|
|
7952
7952
|
* Public Key ID
|
|
@@ -7961,7 +7961,7 @@ Use this endpoint to remove unused SSH keys from account.
|
|
|
7961
7961
|
|
|
7962
7962
|
Use this endpoint to view available SSH keys for VPS authentication.
|
|
7963
7963
|
*/
|
|
7964
|
-
"
|
|
7964
|
+
"vps_public-keys_list": {
|
|
7965
7965
|
params: {
|
|
7966
7966
|
/**
|
|
7967
7967
|
* Page number
|
|
@@ -7976,7 +7976,7 @@ Use this endpoint to view available SSH keys for VPS authentication.
|
|
|
7976
7976
|
|
|
7977
7977
|
Use this endpoint to register SSH keys for VPS authentication.
|
|
7978
7978
|
*/
|
|
7979
|
-
"
|
|
7979
|
+
"vps_public-keys_create": {
|
|
7980
7980
|
params: {
|
|
7981
7981
|
/**
|
|
7982
7982
|
* name parameter
|
|
@@ -7995,7 +7995,7 @@ Use this endpoint to register SSH keys for VPS authentication.
|
|
|
7995
7995
|
|
|
7996
7996
|
Use this endpoint to view specific template specifications before deployment.
|
|
7997
7997
|
*/
|
|
7998
|
-
"
|
|
7998
|
+
"vps_templates_get": {
|
|
7999
7999
|
params: {
|
|
8000
8000
|
/**
|
|
8001
8001
|
* Template ID
|
|
@@ -8010,7 +8010,7 @@ Use this endpoint to view specific template specifications before deployment.
|
|
|
8010
8010
|
|
|
8011
8011
|
Use this endpoint to view operating system options before creating or recreating VPS instances.
|
|
8012
8012
|
*/
|
|
8013
|
-
"
|
|
8013
|
+
"vps_templates_list": {
|
|
8014
8014
|
params: {
|
|
8015
8015
|
|
|
8016
8016
|
};
|
|
@@ -8022,7 +8022,7 @@ Use this endpoint to view operating system options before creating or recreating
|
|
|
8022
8022
|
|
|
8023
8023
|
Use this endpoint to monitor specific VPS operation status and details.
|
|
8024
8024
|
*/
|
|
8025
|
-
"
|
|
8025
|
+
"vps_actions_get": {
|
|
8026
8026
|
params: {
|
|
8027
8027
|
/**
|
|
8028
8028
|
* Virtual Machine ID
|
|
@@ -8046,7 +8046,7 @@ each action, such as the action name, timestamp, and status.
|
|
|
8046
8046
|
|
|
8047
8047
|
Use this endpoint to view VPS operation history and troubleshoot issues.
|
|
8048
8048
|
*/
|
|
8049
|
-
"
|
|
8049
|
+
"vps_actions_list": {
|
|
8050
8050
|
params: {
|
|
8051
8051
|
/**
|
|
8052
8052
|
* Virtual Machine ID
|
|
@@ -8065,7 +8065,7 @@ Use this endpoint to view VPS operation history and troubleshoot issues.
|
|
|
8065
8065
|
|
|
8066
8066
|
Use this endpoint to view SSH keys configured for specific VPS instances.
|
|
8067
8067
|
*/
|
|
8068
|
-
"
|
|
8068
|
+
"vps_virtual-machines_attached-public-keys": {
|
|
8069
8069
|
params: {
|
|
8070
8070
|
/**
|
|
8071
8071
|
* Virtual Machine ID
|
|
@@ -8084,7 +8084,7 @@ Use this endpoint to view SSH keys configured for specific VPS instances.
|
|
|
8084
8084
|
|
|
8085
8085
|
Use this endpoint to view available backup points for VPS data recovery.
|
|
8086
8086
|
*/
|
|
8087
|
-
"
|
|
8087
|
+
"vps_backups_list": {
|
|
8088
8088
|
params: {
|
|
8089
8089
|
/**
|
|
8090
8090
|
* Virtual Machine ID
|
|
@@ -8107,7 +8107,7 @@ The system will then initiate the restore process, which may take some time depe
|
|
|
8107
8107
|
|
|
8108
8108
|
Use this endpoint to recover VPS data from backup points.
|
|
8109
8109
|
*/
|
|
8110
|
-
"
|
|
8110
|
+
"vps_backups_restore": {
|
|
8111
8111
|
params: {
|
|
8112
8112
|
/**
|
|
8113
8113
|
* Virtual Machine ID
|
|
@@ -8130,7 +8130,7 @@ you need to point your domain A/AAAA records to virtual machine IP as well.
|
|
|
8130
8130
|
|
|
8131
8131
|
Use this endpoint to configure custom hostnames for VPS instances.
|
|
8132
8132
|
*/
|
|
8133
|
-
"
|
|
8133
|
+
"vps_virtual-machines_set-hostname": {
|
|
8134
8134
|
params: {
|
|
8135
8135
|
/**
|
|
8136
8136
|
* Virtual Machine ID
|
|
@@ -8149,7 +8149,7 @@ Use this endpoint to configure custom hostnames for VPS instances.
|
|
|
8149
8149
|
|
|
8150
8150
|
Use this endpoint to restore default hostname configuration for VPS instances.
|
|
8151
8151
|
*/
|
|
8152
|
-
"
|
|
8152
|
+
"vps_virtual-machines_reset-hostname": {
|
|
8153
8153
|
params: {
|
|
8154
8154
|
/**
|
|
8155
8155
|
* Virtual Machine ID
|
|
@@ -8164,7 +8164,7 @@ Use this endpoint to restore default hostname configuration for VPS instances.
|
|
|
8164
8164
|
|
|
8165
8165
|
Use this endpoint to view comprehensive VPS configuration and status.
|
|
8166
8166
|
*/
|
|
8167
|
-
"
|
|
8167
|
+
"vps_virtual-machines_get": {
|
|
8168
8168
|
params: {
|
|
8169
8169
|
/**
|
|
8170
8170
|
* Virtual Machine ID
|
|
@@ -8179,7 +8179,7 @@ Use this endpoint to view comprehensive VPS configuration and status.
|
|
|
8179
8179
|
|
|
8180
8180
|
Use this endpoint to view available VPS instances.
|
|
8181
8181
|
*/
|
|
8182
|
-
"
|
|
8182
|
+
"vps_virtual-machines_list": {
|
|
8183
8183
|
params: {
|
|
8184
8184
|
|
|
8185
8185
|
};
|
|
@@ -8200,7 +8200,7 @@ was not set up. Login to
|
|
|
8200
8200
|
|
|
8201
8201
|
Use this endpoint to create new VPS instances.
|
|
8202
8202
|
*/
|
|
8203
|
-
"
|
|
8203
|
+
"vps_virtual-machines_purchase": {
|
|
8204
8204
|
params: {
|
|
8205
8205
|
/**
|
|
8206
8206
|
* Catalog price item ID
|
|
@@ -8233,7 +8233,7 @@ virtual machine and assessing effectiveness of the malware scanner.
|
|
|
8233
8233
|
|
|
8234
8234
|
Use this endpoint to monitor VPS security scan results and threat detection.
|
|
8235
8235
|
*/
|
|
8236
|
-
"
|
|
8236
|
+
"vps_monarx_scan-metrics": {
|
|
8237
8237
|
params: {
|
|
8238
8238
|
/**
|
|
8239
8239
|
* Virtual Machine ID
|
|
@@ -8253,7 +8253,7 @@ protected against malicious software.
|
|
|
8253
8253
|
|
|
8254
8254
|
Use this endpoint to enable malware protection on VPS instances.
|
|
8255
8255
|
*/
|
|
8256
|
-
"
|
|
8256
|
+
"vps_monarx_install": {
|
|
8257
8257
|
params: {
|
|
8258
8258
|
/**
|
|
8259
8259
|
* Virtual Machine ID
|
|
@@ -8270,7 +8270,7 @@ If Monarx is not installed, the request will still be processed without any effe
|
|
|
8270
8270
|
|
|
8271
8271
|
Use this endpoint to remove malware scanner from VPS instances.
|
|
8272
8272
|
*/
|
|
8273
|
-
"
|
|
8273
|
+
"vps_monarx_uninstall": {
|
|
8274
8274
|
params: {
|
|
8275
8275
|
/**
|
|
8276
8276
|
* Virtual Machine ID
|
|
@@ -8292,7 +8292,7 @@ It includes the following metrics:
|
|
|
8292
8292
|
|
|
8293
8293
|
Use this endpoint to monitor VPS performance and resource utilization over time.
|
|
8294
8294
|
*/
|
|
8295
|
-
"
|
|
8295
|
+
"vps_virtual-machines_metrics": {
|
|
8296
8296
|
params: {
|
|
8297
8297
|
/**
|
|
8298
8298
|
* Virtual Machine ID
|
|
@@ -8318,7 +8318,7 @@ machine being unable to resolve domain names.
|
|
|
8318
8318
|
|
|
8319
8319
|
Use this endpoint to configure custom DNS resolvers for VPS instances.
|
|
8320
8320
|
*/
|
|
8321
|
-
"
|
|
8321
|
+
"vps_virtual-machines_set-nameservers": {
|
|
8322
8322
|
params: {
|
|
8323
8323
|
/**
|
|
8324
8324
|
* Virtual Machine ID
|
|
@@ -8345,7 +8345,7 @@ Use this endpoint to configure custom DNS resolvers for VPS instances.
|
|
|
8345
8345
|
|
|
8346
8346
|
Use this endpoint to configure reverse DNS lookup for VPS IP addresses.
|
|
8347
8347
|
*/
|
|
8348
|
-
"
|
|
8348
|
+
"vps_ptr_create": {
|
|
8349
8349
|
params: {
|
|
8350
8350
|
/**
|
|
8351
8351
|
* Virtual Machine ID
|
|
@@ -8371,7 +8371,7 @@ no longer return the previously configured hostname.
|
|
|
8371
8371
|
|
|
8372
8372
|
Use this endpoint to remove reverse DNS configuration from VPS instances.
|
|
8373
8373
|
*/
|
|
8374
|
-
"
|
|
8374
|
+
"vps_ptr_delete": {
|
|
8375
8375
|
params: {
|
|
8376
8376
|
/**
|
|
8377
8377
|
* Virtual Machine ID
|
|
@@ -8394,7 +8394,7 @@ endpoint](/#tag/vps-virtual-machine/POST/api/vps/v1/virtual-machines/{virtualMac
|
|
|
8394
8394
|
|
|
8395
8395
|
Use this endpoint to configure control panel access credentials for VPS instances.
|
|
8396
8396
|
*/
|
|
8397
|
-
"
|
|
8397
|
+
"vps_virtual-machines_set-panel-password": {
|
|
8398
8398
|
params: {
|
|
8399
8399
|
/**
|
|
8400
8400
|
* Virtual Machine ID
|
|
@@ -8419,7 +8419,7 @@ Virtual machine will boot recovery disk image and original disk image will be mo
|
|
|
8419
8419
|
|
|
8420
8420
|
Use this endpoint to enable system rescue operations on VPS instances.
|
|
8421
8421
|
*/
|
|
8422
|
-
"
|
|
8422
|
+
"vps_recovery_start": {
|
|
8423
8423
|
params: {
|
|
8424
8424
|
/**
|
|
8425
8425
|
* Virtual Machine ID
|
|
@@ -8440,7 +8440,7 @@ If virtual machine is not in recovery mode, this operation will fail.
|
|
|
8440
8440
|
|
|
8441
8441
|
Use this endpoint to exit system rescue mode and return VPS to normal operation.
|
|
8442
8442
|
*/
|
|
8443
|
-
"
|
|
8443
|
+
"vps_recovery_stop": {
|
|
8444
8444
|
params: {
|
|
8445
8445
|
/**
|
|
8446
8446
|
* Virtual Machine ID
|
|
@@ -8470,7 +8470,7 @@ Requirements for the password are:
|
|
|
8470
8470
|
|
|
8471
8471
|
Use this endpoint to completely rebuild VPS instances with fresh OS installation.
|
|
8472
8472
|
*/
|
|
8473
|
-
"
|
|
8473
|
+
"vps_virtual-machines_recreate": {
|
|
8474
8474
|
params: {
|
|
8475
8475
|
/**
|
|
8476
8476
|
* Virtual Machine ID
|
|
@@ -8506,7 +8506,7 @@ If the virtual machine was stopped, it will be started.
|
|
|
8506
8506
|
|
|
8507
8507
|
Use this endpoint to reboot VPS instances.
|
|
8508
8508
|
*/
|
|
8509
|
-
"
|
|
8509
|
+
"vps_virtual-machines_restart": {
|
|
8510
8510
|
params: {
|
|
8511
8511
|
/**
|
|
8512
8512
|
* Virtual Machine ID
|
|
@@ -8524,7 +8524,7 @@ endpoint](/#tag/vps-virtual-machine/POST/api/vps/v1/virtual-machines/{virtualMac
|
|
|
8524
8524
|
|
|
8525
8525
|
Use this endpoint to update administrator credentials for VPS instances.
|
|
8526
8526
|
*/
|
|
8527
|
-
"
|
|
8527
|
+
"vps_virtual-machines_set-root-password": {
|
|
8528
8528
|
params: {
|
|
8529
8529
|
/**
|
|
8530
8530
|
* Virtual Machine ID
|
|
@@ -8543,7 +8543,7 @@ Use this endpoint to update administrator credentials for VPS instances.
|
|
|
8543
8543
|
|
|
8544
8544
|
Use this endpoint to configure and initialize purchased VPS instances.
|
|
8545
8545
|
*/
|
|
8546
|
-
"
|
|
8546
|
+
"vps_virtual-machines_setup": {
|
|
8547
8547
|
params: {
|
|
8548
8548
|
/**
|
|
8549
8549
|
* Virtual Machine ID
|
|
@@ -8599,7 +8599,7 @@ Password will not be shown in the response.
|
|
|
8599
8599
|
|
|
8600
8600
|
Use this endpoint to view current VPS snapshot information.
|
|
8601
8601
|
*/
|
|
8602
|
-
"
|
|
8602
|
+
"vps_snapshots_get": {
|
|
8603
8603
|
params: {
|
|
8604
8604
|
/**
|
|
8605
8605
|
* Virtual Machine ID
|
|
@@ -8621,7 +8621,7 @@ and testing changes without affecting the current state of the virtual machine.
|
|
|
8621
8621
|
|
|
8622
8622
|
Use this endpoint to capture VPS state for backup and recovery purposes.
|
|
8623
8623
|
*/
|
|
8624
|
-
"
|
|
8624
|
+
"vps_snapshots_create": {
|
|
8625
8625
|
params: {
|
|
8626
8626
|
/**
|
|
8627
8627
|
* Virtual Machine ID
|
|
@@ -8636,7 +8636,7 @@ Use this endpoint to capture VPS state for backup and recovery purposes.
|
|
|
8636
8636
|
|
|
8637
8637
|
Use this endpoint to remove VPS snapshots.
|
|
8638
8638
|
*/
|
|
8639
|
-
"
|
|
8639
|
+
"vps_snapshots_delete": {
|
|
8640
8640
|
params: {
|
|
8641
8641
|
/**
|
|
8642
8642
|
* Virtual Machine ID
|
|
@@ -8654,7 +8654,7 @@ which is useful for system recovery, undoing changes, or testing.
|
|
|
8654
8654
|
|
|
8655
8655
|
Use this endpoint to revert VPS instances to previous saved states.
|
|
8656
8656
|
*/
|
|
8657
|
-
"
|
|
8657
|
+
"vps_snapshots_restore": {
|
|
8658
8658
|
params: {
|
|
8659
8659
|
/**
|
|
8660
8660
|
* Virtual Machine ID
|
|
@@ -8671,7 +8671,7 @@ If the virtual machine is already running, the request will still be processed w
|
|
|
8671
8671
|
|
|
8672
8672
|
Use this endpoint to power on stopped VPS instances.
|
|
8673
8673
|
*/
|
|
8674
|
-
"
|
|
8674
|
+
"vps_virtual-machines_start": {
|
|
8675
8675
|
params: {
|
|
8676
8676
|
/**
|
|
8677
8677
|
* Virtual Machine ID
|
|
@@ -8691,7 +8691,7 @@ disable auto-renewal on the owning subscription.
|
|
|
8691
8691
|
|
|
8692
8692
|
Use this endpoint to power off running VPS instances.
|
|
8693
8693
|
*/
|
|
8694
|
-
"
|
|
8694
|
+
"vps_virtual-machines_stop": {
|
|
8695
8695
|
params: {
|
|
8696
8696
|
/**
|
|
8697
8697
|
* Virtual Machine ID
|
|
@@ -8709,7 +8709,7 @@ option, or omit it to return all options.
|
|
|
8709
8709
|
Provide the WordPress installation (software) identifier in the path. It can
|
|
8710
8710
|
be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field).
|
|
8711
8711
|
*/
|
|
8712
|
-
"
|
|
8712
|
+
"wordpress_ai-tools_show-option-status": {
|
|
8713
8713
|
params: {
|
|
8714
8714
|
/**
|
|
8715
8715
|
* username parameter
|
|
@@ -8734,7 +8734,7 @@ WordPress installation.
|
|
|
8734
8734
|
Provide the WordPress installation (software) identifier in the path. It can
|
|
8735
8735
|
be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field).
|
|
8736
8736
|
*/
|
|
8737
|
-
"
|
|
8737
|
+
"wordpress_ai-tools_set-option-status": {
|
|
8738
8738
|
params: {
|
|
8739
8739
|
/**
|
|
8740
8740
|
* username parameter
|
|
@@ -8765,7 +8765,7 @@ Provide the WordPress installation (software) identifiers in the body. They
|
|
|
8765
8765
|
can be obtained from GET /api/hosting/v1/wordpress/installations (the `id`
|
|
8766
8766
|
field).
|
|
8767
8767
|
*/
|
|
8768
|
-
"
|
|
8768
|
+
"wordpress_installations_check-if-are-valid": {
|
|
8769
8769
|
params: {
|
|
8770
8770
|
/**
|
|
8771
8771
|
* username parameter
|
|
@@ -8791,7 +8791,7 @@ staging websites and any other related data.
|
|
|
8791
8791
|
Provide the WordPress installation (software) identifier in the path. It can
|
|
8792
8792
|
be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field).
|
|
8793
8793
|
*/
|
|
8794
|
-
"
|
|
8794
|
+
"wordpress_installations_delete": {
|
|
8795
8795
|
params: {
|
|
8796
8796
|
/**
|
|
8797
8797
|
* username parameter
|
|
@@ -8812,7 +8812,7 @@ This operation is asynchronous: a successful response only means the scan has
|
|
|
8812
8812
|
been queued. Poll GET /api/hosting/v1/wordpress/installations to fetch the
|
|
8813
8813
|
detected installations once the scan completes.
|
|
8814
8814
|
*/
|
|
8815
|
-
"
|
|
8815
|
+
"wordpress_installations_detect": {
|
|
8816
8816
|
params: {
|
|
8817
8817
|
/**
|
|
8818
8818
|
* username parameter
|
|
@@ -8831,7 +8831,7 @@ verify this is intended before calling this endpoint.
|
|
|
8831
8831
|
This endpoint allows you to import a WordPress website from archive and
|
|
8832
8832
|
database files that have been uploaded to the website's directory.
|
|
8833
8833
|
*/
|
|
8834
|
-
"
|
|
8834
|
+
"wordpress_installations_import-website": {
|
|
8835
8835
|
params: {
|
|
8836
8836
|
/**
|
|
8837
8837
|
* username parameter
|
|
@@ -8871,7 +8871,7 @@ takes 1-2 minutes. Poll GET /api/hosting/v1/wordpress/installations filtered
|
|
|
8871
8871
|
by username and domain to track progress. When the installation appears in
|
|
8872
8872
|
that list, WordPress is ready.
|
|
8873
8873
|
*/
|
|
8874
|
-
"
|
|
8874
|
+
"wordpress_installations_install": {
|
|
8875
8875
|
params: {
|
|
8876
8876
|
/**
|
|
8877
8877
|
* username parameter
|
|
@@ -8928,7 +8928,7 @@ username and domain to narrow results to a specific website.
|
|
|
8928
8928
|
Each installation includes a `valid` flag and, when invalid, a
|
|
8929
8929
|
`validationError` describing why.
|
|
8930
8930
|
*/
|
|
8931
|
-
"
|
|
8931
|
+
"wordpress_installations_list": {
|
|
8932
8932
|
params: {
|
|
8933
8933
|
/**
|
|
8934
8934
|
* Filter by specific username
|
|
@@ -8952,7 +8952,7 @@ Each installation includes a `valid` flag and, when invalid, a
|
|
|
8952
8952
|
Provide the WordPress installation (software) identifier in the path. It can
|
|
8953
8953
|
be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field).
|
|
8954
8954
|
*/
|
|
8955
|
-
"
|
|
8955
|
+
"wordpress_installations_list-core-updates": {
|
|
8956
8956
|
params: {
|
|
8957
8957
|
/**
|
|
8958
8958
|
* username parameter
|
|
@@ -8973,7 +8973,7 @@ WordPress installation, including its MCP (Model Context Protocol) endpoint.
|
|
|
8973
8973
|
Provide the WordPress installation (software) identifier in the path. It can
|
|
8974
8974
|
be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field).
|
|
8975
8975
|
*/
|
|
8976
|
-
"
|
|
8976
|
+
"wordpress_installations_jwt-token": {
|
|
8977
8977
|
params: {
|
|
8978
8978
|
/**
|
|
8979
8979
|
* username parameter
|
|
@@ -8994,7 +8994,7 @@ known vulnerabilities affecting it.
|
|
|
8994
8994
|
Provide the WordPress installation (software) identifier in the path. It can
|
|
8995
8995
|
be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field).
|
|
8996
8996
|
*/
|
|
8997
|
-
"
|
|
8997
|
+
"wordpress_installations_show-core-version": {
|
|
8998
8998
|
params: {
|
|
8999
8999
|
/**
|
|
9000
9000
|
* username parameter
|
|
@@ -9018,7 +9018,7 @@ be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field).
|
|
|
9018
9018
|
This operation is asynchronous: a successful response only means the update
|
|
9019
9019
|
job has been queued.
|
|
9020
9020
|
*/
|
|
9021
|
-
"
|
|
9021
|
+
"wordpress_installations_update-core": {
|
|
9022
9022
|
params: {
|
|
9023
9023
|
/**
|
|
9024
9024
|
* username parameter
|
|
@@ -9046,7 +9046,7 @@ job has been queued.
|
|
|
9046
9046
|
Provide the WordPress installation (software) identifier in the path. It can
|
|
9047
9047
|
be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field).
|
|
9048
9048
|
*/
|
|
9049
|
-
"
|
|
9049
|
+
"wordpress_litespeed-cache_purge-lite-speed": {
|
|
9050
9050
|
params: {
|
|
9051
9051
|
/**
|
|
9052
9052
|
* username parameter
|
|
@@ -9066,7 +9066,7 @@ be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field).
|
|
|
9066
9066
|
Provide the WordPress installation (software) identifier in the path. It can
|
|
9067
9067
|
be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field).
|
|
9068
9068
|
*/
|
|
9069
|
-
"
|
|
9069
|
+
"wordpress_litespeed-cache_show-lite-speed-status": {
|
|
9070
9070
|
params: {
|
|
9071
9071
|
/**
|
|
9072
9072
|
* username parameter
|
|
@@ -9086,7 +9086,7 @@ be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field).
|
|
|
9086
9086
|
Provide the WordPress installation (software) identifier in the path. It can
|
|
9087
9087
|
be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field).
|
|
9088
9088
|
*/
|
|
9089
|
-
"
|
|
9089
|
+
"wordpress_login_create-links": {
|
|
9090
9090
|
params: {
|
|
9091
9091
|
/**
|
|
9092
9092
|
* username parameter
|
|
@@ -9106,7 +9106,7 @@ be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field).
|
|
|
9106
9106
|
Provide the WordPress installation (software) identifier in the path. It can
|
|
9107
9107
|
be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field).
|
|
9108
9108
|
*/
|
|
9109
|
-
"
|
|
9109
|
+
"wordpress_maintenance_show-status": {
|
|
9110
9110
|
params: {
|
|
9111
9111
|
/**
|
|
9112
9112
|
* username parameter
|
|
@@ -9127,7 +9127,7 @@ based on the `enabled` flag.
|
|
|
9127
9127
|
Provide the WordPress installation (software) identifier in the path. It can
|
|
9128
9128
|
be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field).
|
|
9129
9129
|
*/
|
|
9130
|
-
"
|
|
9130
|
+
"wordpress_maintenance_toggle": {
|
|
9131
9131
|
params: {
|
|
9132
9132
|
/**
|
|
9133
9133
|
* username parameter
|
|
@@ -9152,7 +9152,7 @@ installation.
|
|
|
9152
9152
|
Provide the WordPress installation (software) identifier in the path. It can
|
|
9153
9153
|
be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field).
|
|
9154
9154
|
*/
|
|
9155
|
-
"
|
|
9155
|
+
"wordpress_object-cache_show-memcached-status": {
|
|
9156
9156
|
params: {
|
|
9157
9157
|
/**
|
|
9158
9158
|
* username parameter
|
|
@@ -9173,7 +9173,7 @@ installation, based on the `enabled` flag.
|
|
|
9173
9173
|
Provide the WordPress installation (software) identifier in the path. It can
|
|
9174
9174
|
be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field).
|
|
9175
9175
|
*/
|
|
9176
|
-
"
|
|
9176
|
+
"wordpress_object-cache_toggle-memcached": {
|
|
9177
9177
|
params: {
|
|
9178
9178
|
/**
|
|
9179
9179
|
* username parameter
|
|
@@ -9200,7 +9200,7 @@ be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field).
|
|
|
9200
9200
|
This operation is asynchronous: a successful response only means the activation
|
|
9201
9201
|
job has been queued.
|
|
9202
9202
|
*/
|
|
9203
|
-
"
|
|
9203
|
+
"wordpress_plugins_activate": {
|
|
9204
9204
|
params: {
|
|
9205
9205
|
/**
|
|
9206
9206
|
* username parameter
|
|
@@ -9227,7 +9227,7 @@ be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field).
|
|
|
9227
9227
|
This operation is asynchronous: a successful response only means the
|
|
9228
9228
|
deactivation job has been queued.
|
|
9229
9229
|
*/
|
|
9230
|
-
"
|
|
9230
|
+
"wordpress_plugins_deactivate": {
|
|
9231
9231
|
params: {
|
|
9232
9232
|
/**
|
|
9233
9233
|
* username parameter
|
|
@@ -9251,7 +9251,7 @@ deactivation job has been queued.
|
|
|
9251
9251
|
This endpoint allows you to deploy a WordPress plugin that has been uploaded to the website's directory.
|
|
9252
9252
|
The plugin will be activated and made available in the WordPress admin panel.
|
|
9253
9253
|
*/
|
|
9254
|
-
"
|
|
9254
|
+
"wordpress_plugins_deploy": {
|
|
9255
9255
|
params: {
|
|
9256
9256
|
/**
|
|
9257
9257
|
* username parameter
|
|
@@ -9284,7 +9284,7 @@ slugs available for installation.
|
|
|
9284
9284
|
This operation is asynchronous: a successful response only means the install
|
|
9285
9285
|
job has been queued, not that the plugins are ready.
|
|
9286
9286
|
*/
|
|
9287
|
-
"
|
|
9287
|
+
"wordpress_plugins_install": {
|
|
9288
9288
|
params: {
|
|
9289
9289
|
/**
|
|
9290
9290
|
* username parameter
|
|
@@ -9309,7 +9309,7 @@ not yet installed.
|
|
|
9309
9309
|
Provide the WordPress installation (software) identifier in the path. It can
|
|
9310
9310
|
be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field).
|
|
9311
9311
|
*/
|
|
9312
|
-
"
|
|
9312
|
+
"wordpress_plugins_list": {
|
|
9313
9313
|
params: {
|
|
9314
9314
|
/**
|
|
9315
9315
|
* username parameter
|
|
@@ -9330,7 +9330,7 @@ available updates and known vulnerabilities.
|
|
|
9330
9330
|
Provide the WordPress installation (software) identifier in the path. It can
|
|
9331
9331
|
be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field).
|
|
9332
9332
|
*/
|
|
9333
|
-
"
|
|
9333
|
+
"wordpress_plugins_list-installed": {
|
|
9334
9334
|
params: {
|
|
9335
9335
|
/**
|
|
9336
9336
|
* username parameter
|
|
@@ -9354,7 +9354,7 @@ be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field).
|
|
|
9354
9354
|
Use the returned `slug` values with
|
|
9355
9355
|
POST /api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/install.
|
|
9356
9356
|
*/
|
|
9357
|
-
"
|
|
9357
|
+
"wordpress_plugins_search": {
|
|
9358
9358
|
params: {
|
|
9359
9359
|
/**
|
|
9360
9360
|
* Search term to match against plugin names. Minimum 3 characters.
|
|
@@ -9370,7 +9370,7 @@ POST /api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/install.
|
|
|
9370
9370
|
Use the returned `slug` values with
|
|
9371
9371
|
POST /api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/install.
|
|
9372
9372
|
*/
|
|
9373
|
-
"
|
|
9373
|
+
"wordpress_plugins_list-suggested": {
|
|
9374
9374
|
params: {
|
|
9375
9375
|
/**
|
|
9376
9376
|
* Optionally scope suggestions to a specific order.
|
|
@@ -9384,7 +9384,7 @@ POST /api/hosting/v1/accounts/{username}/wordpress/{software}/plugins/install.
|
|
|
9384
9384
|
* Check whether WooCommerce is installed on any WordPress installation of a
|
|
9385
9385
|
domain. Optionally filter by domain to scope the check.
|
|
9386
9386
|
*/
|
|
9387
|
-
"
|
|
9387
|
+
"wordpress_plugins_check-if-woo-commerce-is-installed": {
|
|
9388
9388
|
params: {
|
|
9389
9389
|
/**
|
|
9390
9390
|
* Filter by domain name (case-insensitive substring match)
|
|
@@ -9403,7 +9403,7 @@ be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field).
|
|
|
9403
9403
|
This operation is asynchronous: a successful response only means the uninstall
|
|
9404
9404
|
job has been queued.
|
|
9405
9405
|
*/
|
|
9406
|
-
"
|
|
9406
|
+
"wordpress_plugins_uninstall": {
|
|
9407
9407
|
params: {
|
|
9408
9408
|
/**
|
|
9409
9409
|
* username parameter
|
|
@@ -9430,7 +9430,7 @@ be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field).
|
|
|
9430
9430
|
This operation is asynchronous: a successful response only means the update job
|
|
9431
9431
|
has been queued.
|
|
9432
9432
|
*/
|
|
9433
|
-
"
|
|
9433
|
+
"wordpress_plugins_update-hostinger": {
|
|
9434
9434
|
params: {
|
|
9435
9435
|
/**
|
|
9436
9436
|
* username parameter
|
|
@@ -9458,7 +9458,7 @@ be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field).
|
|
|
9458
9458
|
This operation is asynchronous: a successful response only means the update job
|
|
9459
9459
|
has been queued.
|
|
9460
9460
|
*/
|
|
9461
|
-
"
|
|
9461
|
+
"wordpress_plugins_update": {
|
|
9462
9462
|
params: {
|
|
9463
9463
|
/**
|
|
9464
9464
|
* username parameter
|
|
@@ -9485,7 +9485,7 @@ be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field).
|
|
|
9485
9485
|
This operation is asynchronous: a successful response only means the activation
|
|
9486
9486
|
job has been queued.
|
|
9487
9487
|
*/
|
|
9488
|
-
"
|
|
9488
|
+
"wordpress_themes_activate": {
|
|
9489
9489
|
params: {
|
|
9490
9490
|
/**
|
|
9491
9491
|
* username parameter
|
|
@@ -9509,7 +9509,7 @@ job has been queued.
|
|
|
9509
9509
|
This endpoint allows you to deploy a WordPress theme that has been uploaded to the website's directory.
|
|
9510
9510
|
The theme can be optionally activated after deployment.
|
|
9511
9511
|
*/
|
|
9512
|
-
"
|
|
9512
|
+
"wordpress_themes_deploy": {
|
|
9513
9513
|
params: {
|
|
9514
9514
|
/**
|
|
9515
9515
|
* username parameter
|
|
@@ -9550,7 +9550,7 @@ palette1, layout1, default). For any other theme they are ignored.
|
|
|
9550
9550
|
This operation is asynchronous: a successful response only means the install
|
|
9551
9551
|
job has been queued, not that the theme is ready.
|
|
9552
9552
|
*/
|
|
9553
|
-
"
|
|
9553
|
+
"wordpress_themes_install": {
|
|
9554
9554
|
params: {
|
|
9555
9555
|
/**
|
|
9556
9556
|
* username parameter
|
|
@@ -9587,7 +9587,7 @@ available updates and known vulnerabilities.
|
|
|
9587
9587
|
Provide the WordPress installation (software) identifier in the path. It can
|
|
9588
9588
|
be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field).
|
|
9589
9589
|
*/
|
|
9590
|
-
"
|
|
9590
|
+
"wordpress_themes_list-installed": {
|
|
9591
9591
|
params: {
|
|
9592
9592
|
/**
|
|
9593
9593
|
* username parameter
|
|
@@ -9607,7 +9607,7 @@ be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field).
|
|
|
9607
9607
|
Use the returned `slug` values with
|
|
9608
9608
|
POST /api/hosting/v1/accounts/{username}/wordpress/{software}/themes/install.
|
|
9609
9609
|
*/
|
|
9610
|
-
"
|
|
9610
|
+
"wordpress_themes_list": {
|
|
9611
9611
|
params: {
|
|
9612
9612
|
/**
|
|
9613
9613
|
* Optionally scope themes to a specific order.
|
|
@@ -9630,7 +9630,7 @@ be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field).
|
|
|
9630
9630
|
This operation is asynchronous: a successful response only means the uninstall
|
|
9631
9631
|
job has been queued.
|
|
9632
9632
|
*/
|
|
9633
|
-
"
|
|
9633
|
+
"wordpress_themes_uninstall": {
|
|
9634
9634
|
params: {
|
|
9635
9635
|
/**
|
|
9636
9636
|
* username parameter
|
|
@@ -9658,7 +9658,7 @@ be obtained from GET /api/hosting/v1/wordpress/installations (the `id` field).
|
|
|
9658
9658
|
This operation is asynchronous: a successful response only means the update job
|
|
9659
9659
|
has been queued.
|
|
9660
9660
|
*/
|
|
9661
|
-
"
|
|
9661
|
+
"wordpress_themes_update": {
|
|
9662
9662
|
params: {
|
|
9663
9663
|
/**
|
|
9664
9664
|
* username parameter
|