-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathchainstack-platform-api-openapi.yml
More file actions
4616 lines (4604 loc) · 141 KB
/
chainstack-platform-api-openapi.yml
File metadata and controls
4616 lines (4604 loc) · 141 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
---
openapi: 3.0.3
info:
x-logo:
url: https://chainstack.com/assets/docs/api-docs-logo.svg
backgroundColor: "#F5F8FC"
altText: Chainstack
title: "\U0001F499 CHAINSTACK PLATFORM API"
version: v2
contact:
name: API Support
email: support@chainstack.com
description: |
A set of API endpoints to operate and manage the platform resources.<br>
See also a [quick API tutorial](https://docs.chainstack.com/reference/quick-tutorial).
paths:
"/v1/organization/":
get:
operationId: getOrganizatonInfo
summary: Get Organization name and ID
description: Get the name and ID of your organization.
tags:
- Organization
security:
- APIKeyAuthentication: []
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/Organization"
examples:
organization:
value:
id: RG-123-456
name: My organization
description: ''
patch:
operationId: updateOrganizationInfo
summary: Update Organization name
description: Change the name of your organization.
tags:
- Organization
requestBody:
content:
application/json:
schema:
"$ref": "#/components/schemas/OrganizationUpdate"
examples:
organization:
value:
name: My organization
required: true
security:
- APIKeyAuthentication: []
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/Organization"
examples:
organization:
value:
id: RG-123-456
name: My organization
description: ''
'400':
"$ref": "#/components/responses/ValidationError"
"/v1/projects/":
get:
operationId: listAllProjects
summary: List all Projects
description: List all projects your organization is part of.
parameters:
- "$ref": "#/components/parameters/ProjectOrdering"
- "$ref": "#/components/parameters/Pagination"
- "$ref": "#/components/parameters/OrganizationIdFilter"
- "$ref": "#/components/parameters/NameFilter"
- "$ref": "#/components/parameters/ProjectTypeFilter"
tags:
- Project
security:
- APIKeyAuthentication: []
responses:
'200':
content:
application/json:
schema:
allOf:
- "$ref": "#/components/schemas/Pagination"
- type: object
properties:
results:
type: array
items:
"$ref": "#/components/schemas/Project"
examples:
list:
value:
count: 1
next:
previous:
results:
- id: PR-123-456
name: My public chain project
type: public
networks: 0
created_at: '2020-06-15T07:38:00.747Z'
creator:
id: UR-111-111-111
email: john.smith@example.com
first_name: John
last_name: Smith
organization:
id: RG-123-456
name: My organization
description: ''
post:
operationId: createProject
summary: Create Project
description: Create a project.
tags:
- Project
requestBody:
content:
application/json:
schema:
"$ref": "#/components/schemas/ProjectCreate"
examples:
public chain:
"$ref": "#/components/examples/PublicProjectCreate"
required: true
security:
- APIKeyAuthentication: []
responses:
'201':
content:
application/json:
schema:
"$ref": "#/components/schemas/Project"
examples:
public chain:
"$ref": "#/components/examples/PublicProject"
description: ''
'400':
"$ref": "#/components/responses/ValidationError"
"/v1/projects/{id}/":
parameters:
- "$ref": "#/components/parameters/Id"
get:
operationId: retrieveProject
summary: Retrieve Project
description: Retrieve the project details.
tags:
- Project
security:
- APIKeyAuthentication: []
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/Project"
examples:
public chain:
"$ref": "#/components/examples/PublicProject"
description: ''
'404':
"$ref": "#/components/responses/NotFoundError"
patch:
operationId: updateProject
summary: Update Project
description: Change project name and project description.
tags:
- Project
requestBody:
content:
application/json:
schema:
"$ref": "#/components/schemas/ProjectUpdate"
examples:
project:
value:
name: My new project name
description: My new project description
security:
- APIKeyAuthentication: []
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/Project"
examples:
public chain:
"$ref": "#/components/examples/PublicProject"
description: ''
'400':
"$ref": "#/components/responses/ValidationError"
'404':
"$ref": "#/components/responses/NotFoundError"
delete:
operationId: deleteProject
summary: Delete Project
description: Delete the project.
tags:
- Project
security:
- APIKeyAuthentication: []
responses:
'204':
description: No response body
'404':
"$ref": "#/components/responses/NotFoundError"
"/v1/projects/{id}/members/":
get:
operationId: retrieveProjectMembers
summary: Retrieve Project members
description: Retrieve members of a consortium project.
parameters:
- "$ref": "#/components/parameters/Id"
- "$ref": "#/components/parameters/Pagination"
tags:
- Project
security:
- APIKeyAuthentication: []
responses:
'200':
content:
application/json:
schema:
allOf:
- "$ref": "#/components/schemas/Pagination"
- type: object
properties:
results:
type: array
items:
"$ref": "#/components/schemas/ProjectMember"
examples:
list:
value:
count: 1
next:
previous:
results:
- id: RG-123-456
name: My organization
email: john.smith@example.com
description: ''
'404':
"$ref": "#/components/responses/NotFoundError"
"/v1/networks/":
get:
operationId: listAllNetworks
summary: List all Networks
description: List all networks your organization is part of.
parameters:
- "$ref": "#/components/parameters/NetworkOrdering"
- "$ref": "#/components/parameters/Pagination"
- "$ref": "#/components/parameters/ProjectIdFilter"
- "$ref": "#/components/parameters/NameFilter"
- "$ref": "#/components/parameters/PublicNetworkNameFilter"
- "$ref": "#/components/parameters/NetworkStatusFilter"
- "$ref": "#/components/parameters/ProtocolFilter"
- "$ref": "#/components/parameters/NetworkProjectTypeFilter"
tags:
- Network
security:
- APIKeyAuthentication: []
responses:
'200':
content:
application/json:
schema:
allOf:
- "$ref": "#/components/schemas/Pagination"
- type: object
properties:
results:
type: array
items:
"$ref": "#/components/schemas/Network"
examples:
list:
value:
count: 1
next:
previous:
results:
- id: NW-123-456-7
name: Mainnet
project: PR-123-456
protocol: polygon-pos
configuration:
network: polygon-pos-mainnet
details: {}
status: ok
nodes:
- id: ND-123-456-789
name: My Polygon PoS node
network: NW-123-456-7
organization: RG-123-456
type: dedicated
role: peer
provider: gcloud
region: asia-southeast1
status: running
configuration:
archive: true
details:
mode: archive
version: 1.0.6
api_namespaces:
- net
- eth
- web3
- txpool
- debug
- parlia
graphql_endpoint: https://nd-123-456-789.p2pify.com/graphql
https_endpoint: https://nd-123-456-789.p2pify.com
wss_endpoint: wss://ws-nd-123-456-789.p2pify.com
auth_username: user-name
auth_password: pass-word-pass-word-pass-word
auth_key: 3c6e0b8a9c15224a8228b9a98ca1531d
created_at: '2020-06-15T07:38:00.747Z'
creator:
id: UR-111-111-111
email: john.smith@example.com
first_name: John
last_name: Smith
organization:
id: RG-123-456
name: My organization
created_at: '2020-06-15T07:38:00.747Z'
creator:
id: UR-111-111-111
email: john.smith@example.com
first_name: John
last_name: Smith
organization:
id: RG-123-456
name: My organization
description: ''
post:
operationId: createNetwork
summary: Create Network
description: Create a network.
tags:
- Network
requestBody:
content:
application/json:
schema:
"$ref": "#/components/schemas/NetworkCreate"
examples:
ethereum:
"$ref": "#/components/examples/EthereumNetworkCreate"
polygon pos:
"$ref": "#/components/examples/PolygonPoSNetworkCreate"
bsc:
"$ref": "#/components/examples/BinanceSmartChainNetworkCreate"
avalanche:
"$ref": "#/components/examples/AvalancheNetworkCreate"
arbitrum:
"$ref": "#/components/examples/ArbitrumNetworkCreate"
near:
"$ref": "#/components/examples/NearNetworkCreate"
aurora:
"$ref": "#/components/examples/AuroraNetworkCreate"
gnosis:
"$ref": "#/components/examples/GnosisNetworkCreate"
cronos:
"$ref": "#/components/examples/CronosNetworkCreate"
fantom:
"$ref": "#/components/examples/FantomNetworkCreate"
tezos:
"$ref": "#/components/examples/TezosNetworkCreate"
solana:
"$ref": "#/components/examples/SolanaNetworkCreate"
starknet:
"$ref": "#/components/examples/StarknetNetworkCreate"
fuse:
"$ref": "#/components/examples/FuseNetworkCreate"
bitcoin:
"$ref": "#/components/examples/BitcoinNetworkCreate"
harmony:
"$ref": "#/components/examples/HarmonyNetworkCreate"
required: true
security:
- APIKeyAuthentication: []
responses:
'201':
content:
application/json:
schema:
"$ref": "#/components/schemas/Network"
examples:
ethereum:
"$ref": "#/components/examples/EthereumNetwork"
polygon pos:
"$ref": "#/components/examples/PolygonPoSNetwork"
bsc:
"$ref": "#/components/examples/BinanceSmartChainNetwork"
avalanche:
"$ref": "#/components/examples/AvalancheNetwork"
arbitrum:
"$ref": "#/components/examples/ArbitrumNetwork"
near:
"$ref": "#/components/examples/NearNetwork"
aurora:
"$ref": "#/components/examples/AuroraNetwork"
gnosis:
"$ref": "#/components/examples/GnosisNetwork"
cronos:
"$ref": "#/components/examples/CronosNetwork"
fantom:
"$ref": "#/components/examples/FantomNetwork"
tezos:
"$ref": "#/components/examples/TezosNetwork"
solana:
"$ref": "#/components/examples/SolanaNetwork"
starknet:
"$ref": "#/components/examples/StarknetNetwork"
fuse:
"$ref": "#/components/examples/FuseNetwork"
bitcoin:
"$ref": "#/components/examples/BitcoinNetwork"
harmony:
"$ref": "#/components/examples/HarmonyNetwork"
description: ''
'400':
"$ref": "#/components/responses/ValidationError"
"/v1/networks/{id}/":
parameters:
- "$ref": "#/components/parameters/Id"
get:
operationId: retrieveNetwork
summary: Retrieve Network
description: Retrieve network details.
tags:
- Network
security:
- APIKeyAuthentication: []
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/Network"
examples:
ethereum:
"$ref": "#/components/examples/EthereumNetwork"
polygon pos:
"$ref": "#/components/examples/PolygonPoSNetwork"
bsc:
"$ref": "#/components/examples/BinanceSmartChainNetwork"
avalanche:
"$ref": "#/components/examples/AvalancheNetwork"
arbitrum:
"$ref": "#/components/examples/ArbitrumNetwork"
near:
"$ref": "#/components/examples/NearNetwork"
aurora:
"$ref": "#/components/examples/AuroraNetwork"
gnosis:
"$ref": "#/components/examples/GnosisNetwork"
cronos:
"$ref": "#/components/examples/CronosNetwork"
fantom:
"$ref": "#/components/examples/FantomNetwork"
tezos:
"$ref": "#/components/examples/TezosNetwork"
solana:
"$ref": "#/components/examples/SolanaNetwork"
starknet:
"$ref": "#/components/examples/StarknetNetwork"
fuse:
"$ref": "#/components/examples/FuseNetwork"
bitcoin:
"$ref": "#/components/examples/BitcoinNetwork"
harmony:
"$ref": "#/components/examples/HarmonyNetwork"
description: ''
'404':
"$ref": "#/components/responses/NotFoundError"
patch:
operationId: updateNetwork
summary: Update Network
description: Change the network name. Only for `consortium` projects.
tags:
- Network
requestBody:
content:
application/json:
schema:
"$ref": "#/components/schemas/NetworkUpdate"
examples:
network:
value:
name: My new network name
security:
- APIKeyAuthentication: []
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/Network"
examples:
ethereum:
"$ref": "#/components/examples/EthereumNetwork"
polygon pos:
"$ref": "#/components/examples/PolygonPoSNetwork"
bsc:
"$ref": "#/components/examples/BinanceSmartChainNetwork"
avalanche:
"$ref": "#/components/examples/AvalancheNetwork"
arbitrum:
"$ref": "#/components/examples/ArbitrumNetwork"
near:
"$ref": "#/components/examples/NearNetwork"
aurora:
"$ref": "#/components/examples/AuroraNetwork"
gnosis:
"$ref": "#/components/examples/GnosisNetwork"
cronos:
"$ref": "#/components/examples/CronosNetwork"
fantom:
"$ref": "#/components/examples/FantomNetwork"
tezos:
"$ref": "#/components/examples/TezosNetwork"
solana:
"$ref": "#/components/examples/SolanaNetwork"
starknet:
"$ref": "#/components/examples/StarknetNetwork"
fuse:
"$ref": "#/components/examples/FuseNetwork"
bitcoin:
"$ref": "#/components/examples/BitcoinNetwork"
harmony:
"$ref": "#/components/examples/HarmonyNetwork"
description: ''
'400':
"$ref": "#/components/responses/ValidationError"
'404':
"$ref": "#/components/responses/NotFoundError"
delete:
operationId: deleteNetwork
summary: Delete Network
description: Delete the network.
tags:
- Network
security:
- APIKeyAuthentication: []
responses:
'204':
description: No response body
'404':
"$ref": "#/components/responses/NotFoundError"
"/v1/nodes/":
get:
operationId: listAllNodes
summary: List all Nodes
description: List all nodes in the networks your organization is part of.
parameters:
- "$ref": "#/components/parameters/NodeOrdering"
- "$ref": "#/components/parameters/Pagination"
- "$ref": "#/components/parameters/ProjectIdFilter"
- "$ref": "#/components/parameters/OrganizationIdFilter"
- "$ref": "#/components/parameters/NetworkIdFilter"
- "$ref": "#/components/parameters/RegionFilter"
- "$ref": "#/components/parameters/ProviderFilter"
- "$ref": "#/components/parameters/ProtocolFilter"
- "$ref": "#/components/parameters/NodeStatusFilter"
- "$ref": "#/components/parameters/NodeRoleFilter"
- "$ref": "#/components/parameters/NodeTypeFilter"
- "$ref": "#/components/parameters/ArchiveFilter"
- "$ref": "#/components/parameters/PublicNetworkNameFilter"
- "$ref": "#/components/parameters/NameFilter"
- "$ref": "#/components/parameters/NetworkProjectTypeFilter"
tags:
- Node
security:
- APIKeyAuthentication: []
responses:
'200':
content:
application/json:
schema:
allOf:
- "$ref": "#/components/schemas/Pagination"
- type: object
properties:
results:
type: array
items:
"$ref": "#/components/schemas/Node"
examples:
list:
value:
count: 1
next:
previous:
results:
- id: ND-123-456-789
name: My Polygon PoS archive node
network: NW-123-456-7
organization: RG-123-456
type: dedicated
role: peer
provider: gcloud
region: asia-southeast1
status: running
configuration:
archive: true
details:
mode: archive
version: 1.0.6
api_namespaces:
- net
- eth
- web3
- txpool
- debug
- parlia
graphql_endpoint: https://nd-123-456-789.p2pify.com/graphql
https_endpoint: https://nd-123-456-789.p2pify.com
wss_endpoint: wss://ws-nd-123-456-789.p2pify.com
auth_username: user-name
auth_password: pass-word-pass-word-pass-word
auth_key: 3c6e0b8a9c15224a8228b9a98ca1531d
created_at: '2020-06-15T07:38:00.747Z'
creator:
id: UR-111-111-111
email: john.smith@example.com
first_name: John
last_name: Smith
organization:
id: RG-123-456
name: My organization
description: ''
post:
operationId: createNode
summary: Create Node
description: Create Node
tags:
- Node
requestBody:
content:
application/json:
schema:
"$ref": "#/components/schemas/NodeCreate"
examples:
ethereum:
"$ref": "#/components/examples/EthereumNodeCreate"
polygon pos:
"$ref": "#/components/examples/PolygonPoSNodeCreate"
bsc:
"$ref": "#/components/examples/BinanceSmartChainNodeCreate"
avalanche:
"$ref": "#/components/examples/AvalancheNodeCreate"
fantom:
"$ref": "#/components/examples/FantomNodeCreate"
tezos:
"$ref": "#/components/examples/TezosNodeCreate"
solana:
"$ref": "#/components/examples/SolanaNodeCreate"
starknet:
"$ref": "#/components/examples/StarknetNodeCreate"
bitcoin:
"$ref": "#/components/examples/BitcoinNodeCreate"
harmony:
"$ref": "#/components/examples/HarmonyNodeCreate"
required: true
security:
- APIKeyAuthentication: []
responses:
'201':
content:
application/json:
schema:
"$ref": "#/components/schemas/Node"
examples:
ethereum:
"$ref": "#/components/examples/EthereumNode"
polygon pos:
"$ref": "#/components/examples/PolygonPoSNode"
bsc:
"$ref": "#/components/examples/BinanceSmartChainNode"
avalanche:
"$ref": "#/components/examples/AvalancheNode"
fantom:
"$ref": "#/components/examples/FantomNode"
tezos:
"$ref": "#/components/examples/TezosNode"
solana:
"$ref": "#/components/examples/SolanaNode"
starknet:
"$ref": "#/components/examples/StarknetNode"
bitcoin:
"$ref": "#/components/examples/BitcoinNode"
harmony:
"$ref": "#/components/examples/HarmonyNode"
description: ''
'400':
"$ref": "#/components/responses/ValidationError"
"/v1/nodes/{id}/":
parameters:
- "$ref": "#/components/parameters/Id"
get:
operationId: retrieveNode
summary: Retrieve Node
description: Retrieve node details.
tags:
- Node
security:
- APIKeyAuthentication: []
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/Node"
examples:
ethereum:
"$ref": "#/components/examples/EthereumNode"
polygon pos:
"$ref": "#/components/examples/PolygonPoSNode"
bsc:
"$ref": "#/components/examples/BinanceSmartChainNode"
avalanche:
"$ref": "#/components/examples/AvalancheNode"
fantom:
"$ref": "#/components/examples/FantomNode"
tezos:
"$ref": "#/components/examples/TezosNode"
solana:
"$ref": "#/components/examples/SolanaNode"
starknet:
"$ref": "#/components/examples/StarknetNode"
bitcoin:
"$ref": "#/components/examples/BitcoinNode"
harmony:
"$ref": "#/components/examples/HarmonyNode"
description: ''
'404':
"$ref": "#/components/responses/NotFoundError"
patch:
operationId: updateNode
summary: Update Node
description: Change the node name.
tags:
- Node
requestBody:
content:
application/json:
schema:
"$ref": "#/components/schemas/NodeUpdate"
examples:
node:
value:
name: My new node name
security:
- APIKeyAuthentication: []
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/Node"
examples:
ethereum:
"$ref": "#/components/examples/EthereumNode"
polygon pos:
"$ref": "#/components/examples/PolygonPoSNode"
bsc:
"$ref": "#/components/examples/BinanceSmartChainNode"
avalanche:
"$ref": "#/components/examples/AvalancheNode"
fantom:
"$ref": "#/components/examples/FantomNode"
tezos:
"$ref": "#/components/examples/TezosNode"
solana:
"$ref": "#/components/examples/SolanaNode"
starknet:
"$ref": "#/components/examples/StarknetNode"
bitcoin:
"$ref": "#/components/examples/BitcoinNode"
harmony:
"$ref": "#/components/examples/HarmonyNode"
description: ''
'400':
"$ref": "#/components/responses/ValidationError"
'404':
"$ref": "#/components/responses/NotFoundError"
delete:
operationId: deleteNode
summary: Delete Node
description: Delete the node.
tags:
- Node
security:
- APIKeyAuthentication: []
responses:
'204':
description: No response body
'404':
"$ref": "#/components/responses/NotFoundError"
"/v1/faucet/sepolia":
post:
operationId: sepoliaGoerli
summary: Sepolia Faucet
description: Request test tokens.
tags:
- Faucet
requestBody:
content:
application/json:
schema:
"$ref": "#/components/schemas/FaucetSepoliaRequest"
examples:
value:
value:
address: '0x1111111111111111111111111111111111111111'
required: true
security:
- APIKeyAuthentication: []
responses:
'200':
description: ''
content:
application/json:
schema:
"$ref": "#/components/schemas/FaucetSepoliaResponse"
examples:
value:
value:
amountSent: 500000000000000000
transaction: https://sepolia.etherscan.io/tx/0x1111111111111111111111111111111111111111111111111111111111111111
'400':
"$ref": "#/components/responses/ValidationError"
'429':
"$ref": "#/components/responses/TooManyRequestsError"
"/v2/deployment-options/":
get:
operationId: listDeploymentOptions
summary: List deployment options
description: |
List all available deployment options for your organization.
Returns the deployable nodes matrix filtered to shared node types on global clouds.
Each option includes the blockchain ID, cloud ID, protocol, network, and available features.
tags:
- Deployment Options
security:
- APIKeyAuthentication: []
responses:
'200':
content:
application/json:
schema:
"$ref": "#/components/schemas/DeploymentOptionsResponse"
examples:
list:
value:
options:
- blockchain: BC-000-000-008
cloud: CC-0016
region: us-east-1
provider: aws
protocol: ethereum
network: ethereum-mainnet
features:
- full
- blockchain: BC-000-000-017
cloud: CC-0016
region: us-east-1
provider: aws
protocol: ethereum
network: ethereum-sepolia-testnet
features:
- full
- blockchain: BC-000-000-015
cloud: CC-0016
region: us-east-1
provider: aws
protocol: solana
network: solana-mainnet
features:
- full
- blockchain: BC-000-000-006
cloud: CC-0016
region: us-east-1
provider: aws
protocol: bsc
network: bsc-mainnet
features:
- full
- blockchain: BC-000-000-010
cloud: CC-0016
region: us-east-1
provider: aws
protocol: polygon-pos
network: polygon-pos-mainnet
features:
- full
description: ''
'401':
"$ref": "#/components/responses/UnauthorizedError"
'403':
"$ref": "#/components/responses/ForbiddenError"
"/v2/projects/":
get:
operationId: listAllProjectsV2
summary: List all projects
description: List all projects your organization is part of.
parameters:
- "$ref": "#/components/parameters/ProjectOrdering"
- "$ref": "#/components/parameters/Pagination"
- "$ref": "#/components/parameters/OrganizationIdFilter"
- "$ref": "#/components/parameters/NameFilter"
- "$ref": "#/components/parameters/ProjectTypeFilter"
tags:
- Project V2
security:
- APIKeyAuthentication: []
responses:
'200':
content:
application/json:
schema:
allOf:
- "$ref": "#/components/schemas/Pagination"
- type: object
properties:
results:
type: array
items:
"$ref": "#/components/schemas/Project"
examples:
list:
value:
count: 1
next:
previous:
results:
- id: PR-123-456-789
name: My project
description: My project description
type: public
members: 0
networks: 1
creator:
id: UR-111-111-111
email: user@example.com
first_name: John
last_name: Smith
organization:
id: RG-123-456
name: My organization
created_at: '2023-01-01T00:00:00.000000Z'
description: ''
'401':
"$ref": "#/components/responses/UnauthorizedError"
'403':
"$ref": "#/components/responses/ForbiddenError"
post:
operationId: createProjectV2
summary: Create project
description: Create a project.
tags:
- Project V2
requestBody:
content:
application/json:
schema:
"$ref": "#/components/schemas/ProjectCreate"
examples:
project:
value:
name: My project
description: My project description
required: true
security:
- APIKeyAuthentication: []
responses:
'201':
content:
application/json:
schema:
"$ref": "#/components/schemas/Project"
examples:
project:
value:
id: PR-123-456-789
name: My project
description: My project description