-
Notifications
You must be signed in to change notification settings - Fork 339
/
Swarm.yaml
1951 lines (1880 loc) · 63.7 KB
/
Swarm.yaml
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:
version: 3.2.0
title: Bee API
description: "A list of the currently provided Interfaces to interact with the swarm, implementing file operations and sending messages"
security:
- { }
externalDocs:
description: Browse the documentation @ the Swarm Docs
url: "https://docs.ethswarm.org"
servers:
- url: "http://{apiRoot}:{port}/v1"
variables:
apiRoot:
default: "localhost"
description: Base address of the local bee node main API
port:
default: "1633"
description: Service port provided in bee node config
- url: "http://{apiRoot}:{port}"
variables:
apiRoot:
default: "localhost"
description: Base address of the local bee node main API
port:
default: "1633"
description: Service port provided in bee node config
paths:
"/auth":
post:
summary: "Authenticate - This endpoint is experimental"
tags:
- Auth
security:
- basicAuth: [ ]
requestBody:
required: true
content:
application/json:
schema:
$ref: "SwarmCommon.yaml#/components/schemas/SecurityTokenRequest"
responses:
"201":
description: Ok
content:
application/json:
schema:
$ref: "SwarmCommon.yaml#/components/schemas/SecurityTokenResponse"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"401":
$ref: "SwarmCommon.yaml#/components/responses/401"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
"/refresh":
post:
summary: "Refresh the auth token - This endpoint is experimental"
tags:
- Auth
security:
- bearerAuth: [ ]
requestBody:
required: true
content:
application/json:
schema:
$ref: "SwarmCommon.yaml#/components/schemas/SecurityTokenRequest"
responses:
"201":
description: Ok
content:
application/json:
schema:
$ref: "SwarmCommon.yaml#/components/schemas/SecurityTokenResponse"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"401":
$ref: "SwarmCommon.yaml#/components/responses/401"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
"/bytes":
post:
summary: "Upload data"
tags:
- Bytes
parameters:
- in: header
schema:
$ref: "SwarmCommon.yaml#/components/parameters/SwarmPostageBatchId"
name: swarm-postage-batch-id
required: true
- in: header
schema:
$ref: "SwarmCommon.yaml#/components/parameters/SwarmTagParameter"
name: swarm-tag
required: false
- in: header
schema:
$ref: "SwarmCommon.yaml#/components/parameters/SwarmPinParameter"
name: swarm-pin
required: false
- in: header
schema:
$ref: "SwarmCommon.yaml#/components/parameters/SwarmDeferredUpload"
name: swarm-deferred-upload
required: false
- in: header
schema:
$ref: "SwarmCommon.yaml#/components/parameters/SwarmEncryptParameter"
name: swarm-encrypt
required: false
requestBody:
content:
application/octet-stream:
schema:
type: string
format: binary
responses:
"201":
description: Ok
headers:
"swarm-tag":
$ref: "SwarmCommon.yaml#/components/headers/SwarmTag"
content:
application/json:
schema:
$ref: "SwarmCommon.yaml#/components/schemas/ReferenceResponse"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"402":
$ref: "SwarmCommon.yaml#/components/responses/402"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
"/bytes/{reference}":
get:
summary: "Get referenced data"
tags:
- Bytes
parameters:
- in: path
name: reference
schema:
$ref: "SwarmCommon.yaml#/components/schemas/SwarmReference"
required: true
description: Swarm address reference to content
responses:
"200":
description: Retrieved content specified by reference
content:
application/octet-stream:
schema:
type: string
format: binary
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
default:
description: Default response
"/chunks":
post:
summary: "Upload Chunk"
tags:
- Chunk
parameters:
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmTagParameter"
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmPinParameter"
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmPostageBatchId"
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmDeferredUpload"
requestBody:
description: Chunk binary data that has to have at least 8 bytes.
content:
application/octet-stream:
schema:
type: string
format: binary
responses:
"201":
description: Ok
headers:
"swarm-tag":
description: Tag UID if it was passed to the request `swarm-tag` header.
schema:
$ref: "SwarmCommon.yaml#/components/schemas/Uid"
content:
application/json:
schema:
$ref: "SwarmCommon.yaml#/components/schemas/Status"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"402":
$ref: "SwarmCommon.yaml#/components/responses/402"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
"/chunks/stream":
get:
summary: "Upload stream of chunks"
tags:
- Chunk
parameters:
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmTagParameter"
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmPinParameter"
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmPostageBatchId"
responses:
"200":
description: "Returns a Websocket connection on which stream of chunks can be uploaded. Each chunk sent is acknowledged using a binary response `0` which serves as confirmation of upload of single chunk. Chunks should be packaged as binary messages for uploading."
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
default:
description: Default response
"/bzz":
post:
summary: "Upload file or a collection of files"
description: "In order to upload a collection, user can send a multipart request with all the files populated in the form data with appropriate headers.\n\n
User can also upload a tar file along with the swarm-collection header. This will upload the tar file after extracting the entire directory structure.\n\n
If the swarm-collection header is absent, all requests (including tar files) are considered as single file uploads.\n\n
A multipart request is treated as a collection regardless of whether the swarm-collection header is present. This means in order to serve single files
uploaded as a multipart request, the swarm-index-document header should be used with the name of the file."
tags:
- BZZ
parameters:
- in: query
name: name
schema:
$ref: "SwarmCommon.yaml#/components/schemas/FileName"
required: false
description: Filename when uploading single file
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmTagParameter"
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmPinParameter"
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmEncryptParameter"
- $ref: "SwarmCommon.yaml#/components/parameters/ContentTypePreserved"
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmCollection"
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmIndexDocumentParameter"
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmErrorDocumentParameter"
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmPostageBatchId"
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmDeferredUpload"
requestBody:
content:
multipart/form-data:
schema:
properties:
file:
type: array
items:
type: string
format: binary
application/octet-stream:
schema:
type: string
format: binary
application/x-tar:
schema:
type: string
format: binary
responses:
"201":
description: Ok
headers:
"swarm-tag":
$ref: "SwarmCommon.yaml#/components/headers/SwarmTag"
"etag":
$ref: "SwarmCommon.yaml#/components/headers/ETag"
content:
application/json:
schema:
$ref: "SwarmCommon.yaml#/components/schemas/ReferenceResponse"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"402":
$ref: "SwarmCommon.yaml#/components/responses/402"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
"/bzz/{reference}":
get:
summary: "Get file or index document from a collection of files"
tags:
- BZZ
parameters:
- in: path
name: reference
schema:
$ref: "SwarmCommon.yaml#/components/schemas/SwarmReference"
required: true
description: Swarm address of content
responses:
"200":
description: Ok
# "swarm-feed-index":
# $ref: "SwarmCommon.yaml#/components/headers/SwarmFeedIndex"
content:
application/octet-stream:
schema:
type: string
format: binary
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
"/bzz/{reference}/{path}":
get:
summary: "Get referenced file from a collection of files"
tags:
- BZZ
parameters:
- in: path
name: reference
schema:
$ref: "SwarmCommon.yaml#/components/schemas/SwarmReference"
required: true
description: Swarm address of content
- in: path
name: path
schema:
type: string
required: true
description: Path to the file in the collection.
responses:
"200":
description: Ok
content:
application/octet-stream:
schema:
type: string
format: binary
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
"/tags":
get:
summary: Get list of tags
tags:
- Tag
parameters:
- in: query
name: offset
schema:
type: integer
minimum: 0
default: 0
required: false
description: The number of items to skip before starting to collect the result set.
- in: query
name: limit
schema:
type: integer
minimum: 1
maximum: 1000
default: 100
required: false
description: The numbers of items to return.
responses:
"200":
description: List of tags
content:
application/json:
schema:
$ref: "SwarmCommon.yaml#/components/schemas/TagsList"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
post:
summary: "Create Tag"
tags:
- Tag
requestBody:
required: true
content:
application/json:
schema:
$ref: "SwarmCommon.yaml#/components/schemas/NewTagRequest"
responses:
"201":
description: New Tag Info
content:
application/json:
schema:
$ref: "SwarmCommon.yaml#/components/schemas/NewTagResponse"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
"/tags/{uid}":
get:
summary: "Get Tag information using Uid"
tags:
- Tag
parameters:
- in: path
name: uid
schema:
$ref: "SwarmCommon.yaml#/components/schemas/Uid"
required: true
description: Uid
responses:
"200":
description: Tag info
content:
application/json:
schema:
$ref: "SwarmCommon.yaml#/components/schemas/NewTagResponse"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
delete:
summary: "Delete Tag information using Uid"
tags:
- Tag
parameters:
- in: path
name: uid
schema:
$ref: "SwarmCommon.yaml#/components/schemas/Uid"
required: true
description: Uid
responses:
"204":
$ref: "SwarmCommon.yaml#/components/responses/204"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
patch:
summary: "Update Total Count and swarm hash for a tag of an input stream of unknown size using Uid"
tags:
- Tag
parameters:
- in: path
name: uid
schema:
$ref: "SwarmCommon.yaml#/components/schemas/Uid"
required: true
description: Uid
requestBody:
description: Can contain swarm hash to use for the tag
required: false
content:
application/json:
schema:
$ref: "SwarmCommon.yaml#/components/schemas/Address"
responses:
"200":
description: Ok
content:
application/json:
schema:
$ref: "SwarmCommon.yaml#/components/schemas/Status"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
"/pins/{reference}":
parameters:
- in: path
name: reference
schema:
$ref: "SwarmCommon.yaml#/components/schemas/SwarmOnlyReference"
required: true
description: Swarm reference of the root hash
post:
summary: Pin the root hash with the given reference
tags:
- Pinning
responses:
"200":
description: Pin already exists, so no operation
content:
application/json:
schema:
$ref: "SwarmCommon.yaml#/components/schemas/Response"
"201":
description: New pin with root reference was created
content:
application/json:
schema:
$ref: "SwarmCommon.yaml#/components/schemas/Response"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
delete:
summary: Unpin the root hash with the given reference
tags:
- Pinning
responses:
"200":
description: Unpinning root hash with reference
content:
application/json:
schema:
$ref: "SwarmCommon.yaml#/components/schemas/Response"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
get:
summary: Get pinning status of the root hash with the given reference
tags:
- Pinning
responses:
"200":
description: Reference of the pinned root hash
content:
application/json:
schema:
$ref: "SwarmCommon.yaml#/components/schemas/SwarmOnlyReference"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
"/pins":
get:
summary: Get the list of pinned root hash references
tags:
- Pinning
responses:
"200":
description: List of pinned root hash references
content:
application/json:
schema:
$ref: "SwarmCommon.yaml#/components/schemas/SwarmOnlyReferencesList"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
"/pss/send/{topic}/{targets}":
post:
summary: Send to recipient or target with Postal Service for Swarm
tags:
- Postal Service for Swarm
parameters:
- in: path
name: topic
schema:
$ref: "SwarmCommon.yaml#/components/schemas/PssTopic"
required: true
description: Topic name
- in: path
name: targets
schema:
$ref: "SwarmCommon.yaml#/components/schemas/PssTargets"
required: true
description: Target message address prefix. If multiple targets are specified, only one would be matched.
- in: query
name: recipient
schema:
$ref: "SwarmCommon.yaml#/components/schemas/PssRecipient"
required: false
description: Recipient publickey
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmPostageBatchId"
responses:
"201":
description: Subscribed to topic
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"402":
$ref: "SwarmCommon.yaml#/components/responses/402"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
"/pss/subscribe/{topic}":
get:
summary: Subscribe for messages on the given topic.
tags:
- Postal Service for Swarm
parameters:
- in: path
name: topic
schema:
$ref: "SwarmCommon.yaml#/components/schemas/PssTopic"
required: true
description: Topic name
responses:
"200":
description: Returns a WebSocket with a subscription for incoming message data on the requested topic.
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
"/soc/{owner}/{id}":
post:
summary: Upload single owner chunk
tags:
- Single owner chunk
parameters:
- in: path
name: owner
schema:
$ref: "SwarmCommon.yaml#/components/schemas/EthereumAddress"
required: true
description: Owner
- in: path
name: id
schema:
$ref: "SwarmCommon.yaml#/components/schemas/HexString"
required: true
description: Id
- in: query
name: sig
schema:
$ref: "SwarmCommon.yaml#/components/schemas/HexString"
required: true
description: Signature
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmPinParameter"
- in: header
schema:
$ref: "SwarmCommon.yaml#/components/parameters/SwarmPostageBatchId"
name: swarm-postage-batch-id
required: true
responses:
"201":
description: Created
content:
application/json:
schema:
$ref: "SwarmCommon.yaml#/components/schemas/ReferenceResponse"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"401":
$ref: "SwarmCommon.yaml#/components/responses/401"
"402":
$ref: "SwarmCommon.yaml#/components/responses/402"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
"/feeds/{owner}/{topic}":
post:
summary: Create an initial feed root manifest
tags:
- Feed
parameters:
- in: path
name: owner
schema:
$ref: "SwarmCommon.yaml#/components/schemas/EthereumAddress"
required: true
description: Owner
- in: path
name: topic
schema:
$ref: "SwarmCommon.yaml#/components/schemas/HexString"
required: true
description: Topic
- in: query
name: type
schema:
$ref: "SwarmCommon.yaml#/components/schemas/FeedType"
required: false
description: "Feed indexing scheme (default: sequence)"
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmPinParameter"
- $ref: "SwarmCommon.yaml#/components/parameters/SwarmPostageBatchId"
responses:
"201":
description: Created
content:
application/json:
schema:
$ref: "SwarmCommon.yaml#/components/schemas/ReferenceResponse"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"401":
$ref: "SwarmCommon.yaml#/components/responses/401"
"402":
$ref: "SwarmCommon.yaml#/components/responses/402"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
get:
summary: Find feed update
tags:
- Feed
parameters:
- in: path
name: owner
schema:
$ref: "SwarmCommon.yaml#/components/schemas/EthereumAddress"
required: true
description: Owner
- in: path
name: topic
schema:
$ref: "SwarmCommon.yaml#/components/schemas/HexString"
required: true
description: Topic
- in: query
name: at
schema:
type: integer
required: false
description: "Timestamp of the update (default: now)"
- in: query
name: type
schema:
$ref: "SwarmCommon.yaml#/components/schemas/FeedType"
required: false
description: "Feed indexing scheme (default: sequence)"
responses:
"200":
description: Latest feed update
headers:
"swarm-feed-index":
$ref: "SwarmCommon.yaml#/components/headers/SwarmFeedIndex"
"swarm-feed-index-next":
$ref: "SwarmCommon.yaml#/components/headers/SwarmFeedIndexNext"
content:
application/json:
schema:
$ref: "SwarmCommon.yaml#/components/schemas/ReferenceResponse"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"401":
$ref: "SwarmCommon.yaml#/components/responses/401"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
"/stewardship/{reference}":
get:
summary: "Check if content is available"
tags:
- Stewardship
parameters:
- in: path
name: reference
schema:
$ref: "SwarmCommon.yaml#/components/schemas/SwarmReference"
required: true
description: "Root hash of content (can be of any type: collection, file, chunk)"
responses:
"200":
description: Returns if the content is retrievable
content:
application/json:
schema:
$ref: "SwarmCommon.yaml#/components/schemas/IsRetrievableResponse"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
put:
summary: "Reupload a root hash to the network"
tags:
- Stewardship
parameters:
- in: path
name: reference
schema:
$ref: "SwarmCommon.yaml#/components/schemas/SwarmReference"
required: true
description: "Root hash of content (can be of any type: collection, file, chunk)"
responses:
"200":
description: Ok
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"404":
$ref: "SwarmCommon.yaml#/components/responses/404"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
"/addresses":
get:
summary: Get overlay and underlay addresses of the node
description: This endpoint is available on the main API only if the node is spawned with the `--restricted` flag.
tags:
- Connectivity
responses:
"200":
description: Own node underlay and overlay addresses
content:
application/json:
schema:
$ref: "SwarmCommon.yaml#/components/schemas/Addresses"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
"/health":
get:
summary: Get node overall health Status
description: |
Health Status will indicate node healthiness.
If node is unhealthy please check node logs for errors.
tags:
- Status
responses:
"200":
description: Health Status of node
content:
application/json:
schema:
$ref: "SwarmCommon.yaml#/components/schemas/Status"
default:
description: Default response
"/readiness":
get:
summary: Readiness endpoint indicates if node is ready to start accepting traffic
tags:
- Status
responses:
"200":
description: Indicates that node is ready
$ref: "SwarmCommon.yaml#/components/responses/200"
"400":
description: Indicates that node is not ready
$ref: "SwarmCommon.yaml#/components/responses/400"
default:
description: Default response
"/balances":
get:
summary: Get the balances with all known peers including prepaid services
description: This endpoint is available on the main API only if the node is spawned with the `--restricted` flag along with a bearer authentication token.
security:
- bearerAuth: [ ]
tags:
- Balance
responses:
"200":
description: Own balances with all known peers
content:
application/json:
schema:
$ref: "SwarmCommon.yaml#/components/schemas/Balances"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
"/balances/{address}":
get:
summary: Get the balances with a specific peer including prepaid services
description: This endpoint is available on the main API only if the node is spawned with the `--restricted` flag along with a bearer authentication token.
security:
- bearerAuth: [ ]
tags:
- Balance
parameters:
- in: path
name: address
schema:
$ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
required: true
description: Swarm address of peer
responses:
"200":
description: Balance with the specific peer
content:
application/json:
schema:
$ref: "SwarmCommon.yaml#/components/schemas/Balance"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
"/blocklist":
get:
summary: Get a list of blocklisted peers
description: This endpoint is available on the main API only if the node is spawned with the `--restricted` flag along with a bearer authentication token.
security:
- bearerAuth: [ ]
tags:
- Connectivity
responses:
"200":
description: Returns overlay addresses of blocklisted peers
content:
application/json:
schema:
$ref: "SwarmCommon.yaml#/components/schemas/Peers"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
"/consumed":
get:
summary: Get the past due consumption balances with all known peers
description: This endpoint is available on the main API only if the node is spawned with the `--restricted` flag along with a bearer authentication token.
security:
- bearerAuth: [ ]
tags:
- Balance
responses:
"200":
description: Own past due consumption balances with all known peers
content:
application/json:
schema:
$ref: "SwarmCommon.yaml#/components/schemas/Balances"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response
"/consumed/{address}":
get:
summary: Get the past due consumption balance with a specific peer
description: This endpoint is available on the main API only if the node is spawned with the `--restricted` flag along with a bearer authentication token.
security:
- bearerAuth: [ ]
tags:
- Balance
parameters:
- in: path
name: address
schema:
$ref: "SwarmCommon.yaml#/components/schemas/SwarmAddress"
required: true
description: Swarm address of peer
responses:
"200":
description: Past-due consumption balance with the specific peer
content:
application/json:
schema:
$ref: "SwarmCommon.yaml#/components/schemas/Balance"
"400":
$ref: "SwarmCommon.yaml#/components/responses/400"
"500":
$ref: "SwarmCommon.yaml#/components/responses/500"
default:
description: Default response