forked from hostinger/api-mcp-server
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathserver.ts
More file actions
5685 lines (5328 loc) · 177 KB
/
Copy pathserver.ts
File metadata and controls
5685 lines (5328 loc) · 177 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
#!/usr/bin/env node
import { Server } from "@modelcontextprotocol/sdk/server/index.js";
import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
import { StreamableHTTPServerTransport } from "@modelcontextprotocol/sdk/server/streamableHttp.js";
import minimist from 'minimist';
import cors from "cors";
import express from "express";
import {Request, Response} from "express";
import { config as dotenvConfig } from "dotenv";
import {
ListToolsRequestSchema,
CallToolRequestSchema,
Tool,
} from "@modelcontextprotocol/sdk/types.js";
import axios,{ AxiosRequestConfig, AxiosError, AxiosResponse } from "axios";
import * as tus from "tus-js-client";
import fs from "fs";
import path from "path";
// Load environment variables
dotenvConfig();
// Define tool and security scheme types
interface OpenApiTool extends Tool {
method: string;
path: string;
security: any[];
custom?: boolean;
}
interface SecurityScheme {
type: string;
description?: string;
name?: string;
in?: string;
scheme?: string;
}
// Define tool schemas
const TOOLS: OpenApiTool[] = [
{
"name": "hosting_importWordpressWebsite",
"topic": "hosting",
"description": "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. The username will be automatically resolved from the domain.",
"method": "",
"path": "",
"inputSchema": {
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "Domain name associated with the hosting account (e.g., example.com)"
},
"archivePath": {
"type": "string",
"description": "Absolute or relative path to the website archive file. Supported formats: zip, tar, tar.gz, tgz, 7z, gz, gzip. If user provides directory path, create archive from it before proceeding using EXACTLY this naming pattern: directoryname_YYYYMMDD_HHMMSS.zip (e.g., mywebsite_20250115_143022.zip)"
},
"databaseDump": {
"type": "string",
"description": "Absolute or relative path to a database dump file (.sql)"
}
},
"required": [
"domain",
"archivePath",
"databaseDump"
]
},
"security": [],
"custom": true,
"templateFile": "import-wordpress.template.js",
"templateFileTS": "import-wordpress.template.ts",
"handlerMethod": "handleWordpressWebsiteImport"
},
{
"name": "hosting_deployWordpressPlugin",
"topic": "hosting",
"description": "Deploy a WordPress plugin from a directory to a hosting server. This tool uploads all plugin files and triggers plugin deployment.",
"method": "",
"path": "",
"inputSchema": {
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "Domain name associated with the hosting account (e.g., example.com)"
},
"slug": {
"type": "string",
"description": "WordPress plugin slug (e.g., omnisend)"
},
"pluginPath": {
"type": "string",
"description": "Absolute or relative path to the plugin directory containing all plugin files"
}
},
"required": [
"domain",
"slug",
"pluginPath"
]
},
"security": [],
"custom": true,
"templateFile": "deploy-wordpress-plugin.template.js",
"templateFileTS": "deploy-wordpress-plugin.template.ts",
"handlerMethod": "handleWordpressPluginDeploy"
},
{
"name": "hosting_deployWordpressTheme",
"topic": "hosting",
"description": "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.",
"method": "",
"path": "",
"inputSchema": {
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "Domain name associated with the hosting account (e.g., example.com)"
},
"slug": {
"type": "string",
"description": "WordPress theme slug (e.g., twentytwentyfive)"
},
"themePath": {
"type": "string",
"description": "Absolute or relative path to the theme directory containing all theme files"
},
"activate": {
"type": "boolean",
"description": "Whether to activate the theme after deployment (default: false)"
}
},
"required": [
"domain",
"slug",
"themePath"
]
},
"security": [],
"custom": true,
"templateFile": "deploy-wordpress-theme.template.js",
"templateFileTS": "deploy-wordpress-theme.template.ts",
"handlerMethod": "handleWordpressThemeDeploy"
},
{
"name": "hosting_deployJsApplication",
"topic": "hosting",
"description": "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. After deployment, use the hosting_listJsDeployments tool to check deployment status and track build progress.",
"method": "",
"path": "",
"inputSchema": {
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "Domain name associated with the hosting account (e.g., example.com)"
},
"archivePath": {
"type": "string",
"description": "Absolute or relative path to the application archive file. Supported formats: zip, tar, tar.gz, tgz, 7z, gz, gzip. If user provides directory path, create archive from it before proceeding. IMPORTANT: the archive must ONLY contain application source files, not the build output, skip node_modules directory."
},
"removeArchive": {
"type": "boolean",
"description": "Whether to remove the archive file after successful deployment (default: false)"
}
},
"required": [
"domain",
"archivePath"
]
},
"security": [],
"custom": true,
"templateFile": "deploy-javascript-app.template.js",
"templateFileTS": "deploy-javascript-app.template.ts",
"handlerMethod": "handleJavascriptApplicationDeploy"
},
{
"name": "hosting_deployStaticWebsite",
"topic": "hosting",
"description": "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_deployJsApplication instead. The archive will be extracted and deployed directly without any build steps. The username will be automatically resolved from the domain.",
"method": "",
"path": "",
"inputSchema": {
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "Domain name associated with the hosting account (e.g., example.com)"
},
"archivePath": {
"type": "string",
"description": "Absolute or relative path to the static website archive file. Supported formats: zip, tar, tar.gz, tgz, 7z, gz, gzip. If user provides directory path, create archive from it before proceeding using EXACTLY this naming pattern: directoryname_YYYYMMDD_HHMMSS.zip (e.g., mystaticwebsite_20250115_143022.zip)"
},
"removeArchive": {
"type": "boolean",
"description": "Whether to remove the archive file after successful deployment (default: false)"
}
},
"required": [
"domain",
"archivePath"
]
},
"security": [],
"custom": true,
"templateFile": "deploy-static-website.template.js",
"templateFileTS": "deploy-static-website.template.ts",
"handlerMethod": "handleStaticWebsiteDeploy"
},
{
"name": "hosting_listJsDeployments",
"topic": "hosting",
"description": "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.",
"method": "",
"path": "",
"inputSchema": {
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "Domain name associated with the hosting account (e.g., example.com)"
},
"page": {
"type": "integer",
"description": "Page number for pagination (optional)"
},
"perPage": {
"type": "integer",
"description": "Number of items per page (optional)"
},
"states": {
"type": "array",
"items": {
"type": "string",
"enum": [
"pending",
"completed",
"running",
"failed"
]
},
"description": "Filter by deployment states (optional). Valid values: pending, completed, running, failed"
}
},
"required": [
"domain"
]
},
"security": [],
"custom": true,
"templateFile": "list-javascript-deployments.template.js",
"templateFileTS": "list-javascript-deployments.template.ts",
"handlerMethod": "handleListJavascriptDeployments"
},
{
"name": "hosting_showJsDeploymentLogs",
"topic": "hosting",
"description": "Retrieve logs for a specified JavaScript application deployment for debugging purposes in case of failure.",
"method": "",
"path": "",
"inputSchema": {
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "Domain name associated with the hosting account (e.g., example.com)"
},
"fromLine": {
"type": "integer",
"description": "Line from which to retrieve logs (optional, default 0)"
},
"buildUuid": {
"type": "string",
"description": "UUID of the JavaScript deployment build"
}
},
"required": [
"domain",
"buildUuid"
]
},
"security": [],
"custom": true,
"templateFile": "show-javascript-deployment-logs.template.js",
"templateFileTS": "show-javascript-deployment-logs.template.ts",
"handlerMethod": "handleShowJsDeploymentLogs"
},
{
"name": "billing_getCatalogItemListV1",
"description": "Retrieve catalog items available for order.\n\nPrices in catalog items is displayed as cents (without floating point), e.g: float `17.99` is displayed as integer `1799`.\n\nUse this endpoint to view available services and pricing before placing orders.",
"method": "GET",
"path": "/api/billing/v1/catalog",
"inputSchema": {
"type": "object",
"properties": {
"category": {
"type": "string",
"description": "Filter catalog items by category",
"enum": [
"DOMAIN",
"VPS"
]
},
"name": {
"type": "string",
"description": "Filter catalog items by name. Use `*` for wildcard search, e.g. `.COM*` to find .com domain"
}
},
"required": []
},
"security": [
{
"apiToken": []
}
]
},
{
"name": "billing_createServiceOrderV1",
"description": "Create a new service order. \n\n**DEPRECATED**\n\nTo purchase a domain, use [`POST /api/domains/v1/portfolio`](/#tag/domains-portfolio/POST/api/domains/v1/portfolio) instead.\n\nTo purchase a VPS, use [`POST /api/vps/v1/virtual-machines`](/#tag/vps-virtual-machine/POST/api/vps/v1/virtual-machines) instead.\n\n\nTo place order, you need to provide payment method ID and list of price items from the catalog endpoint together with quantity.\nCoupons also can be provided during order creation.\n\nOrders created using this endpoint will be set for automatic renewal.\n\nSome `credit_card` payments might need additional verification, rendering purchase unprocessed.\nWe recommend use other payment methods than `credit_card` if you encounter this issue.",
"method": "POST",
"path": "/api/billing/v1/orders",
"inputSchema": {
"type": "object",
"properties": {
"payment_method_id": {
"type": "integer",
"description": "Payment method ID"
},
"items": {
"type": "array",
"description": "items parameter",
"items": {
"type": "object",
"description": "items parameter",
"properties": {
"item_id": {
"type": "string",
"description": "Price Item ID"
},
"quantity": {
"type": "integer",
"description": "quantity parameter"
}
},
"required": [
"item_id",
"quantity"
]
}
},
"coupons": {
"type": "array",
"description": "Discount coupon codes",
"items": {
"type": "string",
"description": "coupons parameter"
}
}
},
"required": [
"payment_method_id",
"items"
]
},
"security": [
{
"apiToken": []
}
]
},
{
"name": "billing_setDefaultPaymentMethodV1",
"description": "Set the default payment method for your account.\n\nUse this endpoint to configure the primary payment method for future orders.",
"method": "POST",
"path": "/api/billing/v1/payment-methods/{paymentMethodId}",
"inputSchema": {
"type": "object",
"properties": {
"paymentMethodId": {
"type": "integer",
"description": "Payment method ID"
}
},
"required": [
"paymentMethodId"
]
},
"security": [
{
"apiToken": []
}
]
},
{
"name": "billing_deletePaymentMethodV1",
"description": "Delete a payment method from your account.\n\nUse this endpoint to remove unused payment methods from user accounts.",
"method": "DELETE",
"path": "/api/billing/v1/payment-methods/{paymentMethodId}",
"inputSchema": {
"type": "object",
"properties": {
"paymentMethodId": {
"type": "integer",
"description": "Payment method ID"
}
},
"required": [
"paymentMethodId"
]
},
"security": [
{
"apiToken": []
}
]
},
{
"name": "billing_getPaymentMethodListV1",
"description": "Retrieve available payment methods that can be used for placing new orders.\n\nIf you want to add new payment method, please use [hPanel](https://hpanel.hostinger.com/billing/payment-methods).\n\nUse this endpoint to view available payment options before creating orders.",
"method": "GET",
"path": "/api/billing/v1/payment-methods",
"inputSchema": {
"type": "object",
"properties": {},
"required": []
},
"security": [
{
"apiToken": []
}
]
},
{
"name": "billing_cancelSubscriptionV1",
"description": "Cancel a subscription and stop any further billing.\n\nUse this endpoint when users want to terminate active services.",
"method": "DELETE",
"path": "/api/billing/v1/subscriptions/{subscriptionId}",
"inputSchema": {
"type": "object",
"properties": {
"subscriptionId": {
"type": "string",
"description": "Subscription ID"
}
},
"required": [
"subscriptionId"
]
},
"security": [
{
"apiToken": []
}
]
},
{
"name": "billing_getSubscriptionListV1",
"description": "Retrieve a list of all subscriptions associated with your account.\n\nUse this endpoint to monitor active services and billing status.",
"method": "GET",
"path": "/api/billing/v1/subscriptions",
"inputSchema": {
"type": "object",
"properties": {},
"required": []
},
"security": [
{
"apiToken": []
}
]
},
{
"name": "billing_disableAutoRenewalV1",
"description": "Disable auto-renewal for a subscription.\n\nUse this endpoint when disable auto-renewal for a subscription.",
"method": "DELETE",
"path": "/api/billing/v1/subscriptions/{subscriptionId}/auto-renewal/disable",
"inputSchema": {
"type": "object",
"properties": {
"subscriptionId": {
"type": "string",
"description": "Subscription ID"
}
},
"required": [
"subscriptionId"
]
},
"security": [
{
"apiToken": []
}
]
},
{
"name": "billing_enableAutoRenewalV1",
"description": "Enable auto-renewal for a subscription.\n\nUse this endpoint when enable auto-renewal for a subscription.",
"method": "PATCH",
"path": "/api/billing/v1/subscriptions/{subscriptionId}/auto-renewal/enable",
"inputSchema": {
"type": "object",
"properties": {
"subscriptionId": {
"type": "string",
"description": "Subscription ID"
}
},
"required": [
"subscriptionId"
]
},
"security": [
{
"apiToken": []
}
]
},
{
"name": "DNS_getDNSSnapshotV1",
"description": "Retrieve particular DNS snapshot with contents of DNS zone records.\n\nUse this endpoint to view historical DNS configurations for domains.",
"method": "GET",
"path": "/api/dns/v1/snapshots/{domain}/{snapshotId}",
"inputSchema": {
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "Domain name"
},
"snapshotId": {
"type": "integer",
"description": "Snapshot ID"
}
},
"required": [
"domain",
"snapshotId"
]
},
"security": [
{
"apiToken": []
}
]
},
{
"name": "DNS_getDNSSnapshotListV1",
"description": "Retrieve DNS snapshots for a domain.\n\nUse this endpoint to view available DNS backup points for restoration.",
"method": "GET",
"path": "/api/dns/v1/snapshots/{domain}",
"inputSchema": {
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "Domain name"
}
},
"required": [
"domain"
]
},
"security": [
{
"apiToken": []
}
]
},
{
"name": "DNS_restoreDNSSnapshotV1",
"description": "Restore DNS zone to the selected snapshot.\n\nUse this endpoint to revert domain DNS to a previous configuration.",
"method": "POST",
"path": "/api/dns/v1/snapshots/{domain}/{snapshotId}/restore",
"inputSchema": {
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "Domain name"
},
"snapshotId": {
"type": "integer",
"description": "Snapshot ID"
}
},
"required": [
"domain",
"snapshotId"
]
},
"security": [
{
"apiToken": []
}
]
},
{
"name": "DNS_getDNSRecordsV1",
"description": "Retrieve DNS zone records for a specific domain.\n\nUse this endpoint to view current DNS configuration for domain management.",
"method": "GET",
"path": "/api/dns/v1/zones/{domain}",
"inputSchema": {
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "Domain name"
}
},
"required": [
"domain"
]
},
"security": [
{
"apiToken": []
}
]
},
{
"name": "DNS_updateDNSRecordsV1",
"description": "Update DNS records for the selected domain.\n\nUsing `overwrite = true` will replace existing records with the provided ones. \nOtherwise existing records will be updated and new records will be added.\n\nUse this endpoint to modify domain DNS configuration.",
"method": "PUT",
"path": "/api/dns/v1/zones/{domain}",
"inputSchema": {
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "Domain name"
},
"overwrite": {
"type": "boolean",
"description": "If `true`, resource records (RRs) matching name and type will be deleted and new RRs will be created, otherwise resource records' ttl's are updated and new records are appended. If no matching RRs are found, they are created."
},
"zone": {
"type": "array",
"description": "zone parameter",
"items": {
"type": "object",
"description": "zone parameter",
"properties": {
"name": {
"type": "string",
"description": "Name of the record (use `@` for wildcard name)"
},
"records": {
"type": "array",
"description": "Records assigned to the name",
"items": {
"type": "object",
"description": "records parameter",
"properties": {
"content": {
"type": "string",
"description": "Content of the name record"
}
},
"required": [
"content"
]
}
},
"ttl": {
"type": "integer",
"description": "TTL (Time-To-Live) of the record"
},
"type": {
"type": "string",
"description": "Type of the record",
"enum": [
"A",
"AAAA",
"CNAME",
"ALIAS",
"MX",
"TXT",
"NS",
"SOA",
"SRV",
"CAA"
]
}
},
"required": [
"name",
"records",
"type"
]
}
}
},
"required": [
"domain",
"zone"
]
},
"security": [
{
"apiToken": []
}
]
},
{
"name": "DNS_deleteDNSRecordsV1",
"description": "Delete DNS records for the selected domain.\n\nTo filter which records to delete, add the `name` of the record and `type` to the filter. \nMultiple filters can be provided with single request.\n\nIf you have multiple records with the same name and type, and you want to delete only part of them,\nrefer to the `Update zone records` endpoint.\n\nUse this endpoint to remove specific DNS records from domains.",
"method": "DELETE",
"path": "/api/dns/v1/zones/{domain}",
"inputSchema": {
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "Domain name"
}
},
"required": [
"domain"
]
},
"security": [
{
"apiToken": []
}
]
},
{
"name": "DNS_resetDNSRecordsV1",
"description": "Reset DNS zone to the default records.\n\nUse this endpoint to restore domain DNS to original configuration.",
"method": "POST",
"path": "/api/dns/v1/zones/{domain}/reset",
"inputSchema": {
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "Domain name"
},
"sync": {
"type": "boolean",
"description": "Determines if operation should be run synchronously"
},
"reset_email_records": {
"type": "boolean",
"description": "Determines if email records should be reset"
},
"whitelisted_record_types": {
"type": "array",
"description": "Specifies which record types to not reset",
"items": {
"type": "string",
"description": "whitelisted_record_types parameter"
}
}
},
"required": [
"domain"
]
},
"security": [
{
"apiToken": []
}
]
},
{
"name": "DNS_validateDNSRecordsV1",
"description": "Validate DNS records prior to update for the selected domain.\n\nIf the validation is successful, the response will contain `200 Success` code.\nIf there is validation error, the response will fail with `422 Validation error` code.\n\nUse this endpoint to verify DNS record validity before applying changes.",
"method": "POST",
"path": "/api/dns/v1/zones/{domain}/validate",
"inputSchema": {
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "Domain name"
},
"overwrite": {
"type": "boolean",
"description": "If `true`, resource records (RRs) matching name and type will be deleted and new RRs will be created, otherwise resource records' ttl's are updated and new records are appended. If no matching RRs are found, they are created."
},
"zone": {
"type": "array",
"description": "zone parameter",
"items": {
"type": "object",
"description": "zone parameter",
"properties": {
"name": {
"type": "string",
"description": "Name of the record (use `@` for wildcard name)"
},
"records": {
"type": "array",
"description": "Records assigned to the name",
"items": {
"type": "object",
"description": "records parameter",
"properties": {
"content": {
"type": "string",
"description": "Content of the name record"
}
},
"required": [
"content"
]
}
},
"ttl": {
"type": "integer",
"description": "TTL (Time-To-Live) of the record"
},
"type": {
"type": "string",
"description": "Type of the record",
"enum": [
"A",
"AAAA",
"CNAME",
"ALIAS",
"MX",
"TXT",
"NS",
"SOA",
"SRV",
"CAA"
]
}
},
"required": [
"name",
"records",
"type"
]
}
}
},
"required": [
"domain",
"zone"
]
},
"security": [
{
"apiToken": []
}
]
},
{
"name": "v2_getDomainVerificationsDIRECT",
"description": "Retrieve a list of pending and completed domain verifications.",
"method": "GET",
"path": "/api/v2/direct/verifications/active",
"inputSchema": {
"type": "object",
"properties": {},
"required": []
},
"security": [
{
"apiToken": []
}
]
},
{
"name": "domains_checkDomainAvailabilityV1",
"description": "Check availability of domain names across multiple TLDs.\n\nMultiple TLDs can be checked at once.\nIf you want alternative domains with response, provide only one TLD and set `with_alternatives` to `true`.\nTLDs should be provided without leading dot (e.g. `com`, `net`, `org`).\n\nEndpoint has rate limit of 10 requests per minute.\n\nUse this endpoint to verify domain availability before purchase.",
"method": "POST",
"path": "/api/domains/v1/availability",
"inputSchema": {
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "Domain name (without TLD)"
},
"tlds": {
"type": "array",
"description": "TLDs list",
"items": {
"type": "string",
"description": "TLD without leading dot"
}
},
"with_alternatives": {
"type": "boolean",
"description": "Should response include alternatives"
}
},
"required": [
"domain",
"tlds"
]
},
"security": [
{
"apiToken": []
}
]
},
{
"name": "domains_getDomainForwardingV1",
"description": "Retrieve domain forwarding data.\n\nUse this endpoint to view current redirect configuration for domains.",
"method": "GET",
"path": "/api/domains/v1/forwarding/{domain}",
"inputSchema": {
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "Domain name"
}
},
"required": [
"domain"
]
},
"security": [
{
"apiToken": []
}
]
},
{
"name": "domains_deleteDomainForwardingV1",
"description": "Delete domain forwarding data.\n\nUse this endpoint to remove redirect configuration from domains.",
"method": "DELETE",
"path": "/api/domains/v1/forwarding/{domain}",
"inputSchema": {
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "Domain name"
}
},
"required": [
"domain"
]
},
"security": [
{
"apiToken": []
}
]
},
{
"name": "domains_createDomainForwardingV1",
"description": "Create domain forwarding configuration.\n\nUse this endpoint to set up domain redirects to other URLs.",
"method": "POST",
"path": "/api/domains/v1/forwarding",
"inputSchema": {
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "Domain name"
},
"redirect_type": {
"type": "string",
"description": "Redirect type",
"enum": [
"301",
"302"
]
},
"redirect_url": {
"type": "string",
"description": "URL to forward domain to"
}
},
"required": [
"domain",
"redirect_type",
"redirect_url"
]
},
"security": [
{
"apiToken": []
}
]
},
{
"name": "domains_enableDomainLockV1",
"description": "Enable domain lock for the domain.\n\nWhen domain lock is enabled, the domain cannot be transferred to another registrar without first disabling the lock.\n\nUse this endpoint to secure domains against unauthorized transfers.",
"method": "PUT",
"path": "/api/domains/v1/portfolio/{domain}/domain-lock",
"inputSchema": {
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "Domain name"
}