1"use strict";(self.webpackChunkbee_docs=self.webpackChunkbee_docs||[]).push([[6603],{41837:function(e){e.exports=JSON.parse('{"url":"redocusaurus/plugin-redoc-0.yaml","themeId":"theme-redoc","isSpecFile":true,"spec":{"openapi":"3.0.3","info":{"version":"5.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":"#/components/schemas/SecurityTokenRequest"}}}},"responses":{"201":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityTokenResponse"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/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":"#/components/schemas/SecurityTokenRequest"}}}},"responses":{"201":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityTokenResponse"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}}},"/bytes":{"post":{"summary":"Upload data","tags":["Bytes"],"parameters":[{"in":"header","schema":{"$ref":"#/components/schemas/SwarmPostageBatchId"},"name":"swarm-postage-batch-id","required":true},{"in":"header","schema":{"$ref":"#/components/schemas/SwarmTagParameter"},"name":"swarm-tag","required":false},{"in":"header","schema":{"$ref":"#/components/schemas/SwarmPinParameter"},"name":"swarm-pin","required":false},{"in":"header","schema":{"$ref":"#/components/schemas/SwarmDeferredUpload"},"name":"swarm-deferred-upload","required":false},{"in":"header","schema":{"$ref":"#/components/schemas/SwarmEncryptParameter"},"name":"swarm-encrypt","required":false},{"in":"header","schema":{"$ref":"#/components/schemas/SwarmRedundancyLevelParameter"},"name":"swarm-redundancy-level","required":false}],"requestBody":{"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"201":{"description":"Ok","headers":{"swarm-tag":{"$ref":"#/components/headers/SwarmTag"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReferenceResponse"}}}},"400":{"$ref":"#/components/responses/400"},"402":{"$ref":"#/components/responses/402"},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}}},"/bytes/{reference}":{"get":{"summary":"Get referenced data","tags":["Bytes"],"parameters":[{"in":"path","name":"reference","schema":{"$ref":"#/components/schemas/SwarmReference"},"required":true,"description":"Swarm address reference to content"},{"$ref":"#/components/parameters/SwarmCache"},{"$ref":"#/components/parameters/SwarmRedundancyStrategyParameter"},{"$ref":"#/components/parameters/SwarmRedundancyFallbackModeParameter"},{"$ref":"#/components/parameters/SwarmChunkRetrievalTimeoutParameter"}],"responses":{"200":{"description":"Retrieved content specified by reference","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#/components/responses/400"},"default":{"description":"Default response"}}}},"/chunks":{"post":{"summary":"Upload chunk","tags":["Chunk"],"parameters":[{"$ref":"#/components/parameters/SwarmTagParameter"},{"$ref":"#/components/parameters/SwarmPostageBatchId"}],"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":"#/components/schemas/Uid"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReferenceResponse"}}}},"400":{"$ref":"#/components/responses/400"},"402":{"$ref":"#/components/responses/402"},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}}},"/chunks/stream":{"get":{"summary":"Upload stream of chunks","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. If a tag is specified, the chunks will be streamed into local storage and then be uploaded to the network once the stream is closed. If a tag is not specified, the chunks will bypass local storage and be directly uploaded to the network through the stream as they arrive.","tags":["Chunk"],"parameters":[{"$ref":"#/components/parameters/SwarmTagParameter"},{"$ref":"#/components/parameters/SwarmPostageBatchId"}],"responses":{"200":{"description":"Connection established"},"400":{"$ref":"#/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":"#/components/schemas/FileName"},"required":false,"description":"Filename when uploading single file"},{"$ref":"#/components/parameters/SwarmTagParameter"},{"$ref":"#/components/parameters/SwarmPinParameter"},{"$ref":"#/components/parameters/SwarmEncryptParameter"},{"$ref":"#/components/parameters/ContentTypePreserved"},{"$ref":"#/components/parameters/SwarmCollection"},{"$ref":"#/components/parameters/SwarmIndexDocumentParameter"},{"$ref":"#/components/parameters/SwarmErrorDocumentParameter"},{"$ref":"#/components/parameters/SwarmPostageBatchId"},{"$ref":"#/components/parameters/SwarmDeferredUpload"}
1,{"$ref":"#/components/parameters/SwarmRedundancyLevelParameter"}],"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":"#/components/headers/SwarmTag"},"etag":{"$ref":"#/components/headers/ETag"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReferenceResponse"}}}},"400":{"$ref":"#/components/responses/400"},"402":{"$ref":"#/components/responses/402"},"500":{"$ref":"#/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":"#/components/schemas/SwarmReference"},"required":true,"description":"Swarm address of content"},{"$ref":"#/components/parameters/SwarmCache"},{"$ref":"#/components/parameters/SwarmRedundancyStrategyParameter"},{"$ref":"#/components/parameters/SwarmRedundancyFallbackModeParameter"},{"$ref":"#/components/parameters/SwarmChunkRetrievalTimeoutParameter"}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/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":"#/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."},{"$ref":"#/components/parameters/SwarmRedundancyStrategyParameter"},{"$ref":"#/components/parameters/SwarmRedundancyFallbackModeParameter"},{"$ref":"#/components/parameters/SwarmChunkRetrievalTimeoutParameter"}],"responses":{"200":{"description":"Ok","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/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":"#/components/schemas/TagsList"}}}},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}},"post":{"summary":"Create Tag","tags":["Tag"],"description":"Tags can be thought of as upload sessions which can be tracked using the tags endpoint. It will keep track of the chunks that are uploaded as part of the tag and will push them out to the network once a done split is called on the Tag. This happens internally if you use the `Swarm-Deferred-Upload` header.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewTagRequest"}}}},"responses":{"201":{"description":"New Tag Info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewTagResponse"}}}},"500":{"$ref":"#/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":"#/components/schemas/Uid"},"required":true,"description":"Uid"}],"responses":{"200":{"description":"Tag info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewTagResponse"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}},"delete":{"summary":"Delete Tag information using Uid","tags":["Tag"],"parameters":[{"in":"path","name":"uid","schema":{"$ref":"#/components/schemas/Uid"},"required":true,"description":"Uid"}],"responses":{"204":{"$ref":"#/components/responses/204"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/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":"#/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":"#/components/schemas/Address"}}}},"responses":{"200":{"description":"Ok","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthStatus"}}}},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}}},"/pins/{reference}":{"parameters":[{"in":"path","name":"reference","schema":{"$ref":"#/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":"#/components/schemas/Response"}}}},"201":{"description":"New pin with root reference was created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/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":"#/components/schemas/Response"}}}},"400":{"$ref":"#/components/responses/400"},"500":{"$ref":"#/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":"#/components/schemas/SwarmOnlyReference"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/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":"#/components/schemas/SwarmOnlyReferencesList"}}}},"500":{"$ref":"#/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":"#/components/schemas/PssTopic"},"required":true,"description":"Topic name"},{"in":"path","name":"targets","schema":{"$ref":"#/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":"#/components/schemas/PssRecipient"},"required":false,"description":"Recipient publickey"},{"$ref":"#/components/parameters/SwarmPostageBatchId"}],"responses":{"201":{"description":"Subscribed to topic"},"400":{"$ref":"#/components/responses/400"},"402":{"$ref":"#/components/responses/402"},"500":{"$ref":"#/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":"#/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":"#/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":"#/components/schemas/EthereumAddress"},"required":true,"description":"Owner"},{"in":"path","name":"id","schema":{"$ref":"#/components/schemas/HexString"},"required":true,"description":"Id"},{"in":"query","name":"sig","schema":{"$ref":"#/components/schemas/HexString"},"required":true,"description":"Signature"},{"$ref":"#/components/parameters/SwarmPinParameter"},{"in":"header","schema":{"$ref":"#/components/schemas/SwarmPostageBatchId"},"name":"swarm-postage-batch-id","required":true}],"requestBody":{"required":true,"description":"The SOC binary data is composed of the span (8 bytes) and the at most 4KB payload.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReferenceResponse"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"402":{"$ref":"#/components/responses/402"},"500":{"$ref":"#/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":"#/components/schemas/EthereumAddress"},"required":true,"description":"Owner"},{"in":"path","name":"topic","schema":{"$ref":"#/components/schemas/HexString"},"required":true,"description":"Topic"},{"in":"query","name":"type","schema":{"$ref":"#/components/schemas/FeedType"},"required":false,"description":"Feed indexing scheme (default: sequence)"},{"$ref":"#/components/parameters/SwarmPinParameter"},{"$ref":"#/components/parameters/SwarmPostageBatchId"}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReferenceResponse"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"402":{"$ref":"#/components/responses/402"},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}},"get":{"summary":"Find feed update","tags":["Feed"],"parameters":[{"in":"path","name":"owner","schema":{"$ref":"#/components/schemas/EthereumAddress"},"required":true,"description":"Owner"},{"in":"path","name":"topic","schema":{"$ref":"#/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":"after","schema":{"type":"integer"},"required":false,"description":"Start index (default: 0)"},{"in":"query","name":"type","schema":{"$ref":"#/components/schemas/FeedType"},"required":false,"description":"Feed indexing scheme (default: sequence)"}],"responses":{"200":{"description":"Latest feed update","headers":{"swarm-feed-index":{"$ref":"#/components/headers/SwarmFeedIndex"},"swarm-feed-index-next":{"$ref":"#/components/headers/SwarmFeedIndexNext"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReferenceResponse"}}}},"400":{"$ref":"#/components/responses/400"},"401":{"$ref":"#/components/responses/401"},"500":{"$ref":"#/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":"#/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":"#/components/schemas/IsRetrievableResponse"}}}},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}},"put":{"summary":"Re-upload content for specified root hash","tags":["Stewardship"],"parameters":[{"in":"path","name":"reference","schema":{"$ref":"#/components/schemas/SwarmReference"},"required":true,"description":"Re-uploads content for specified root hash (can be of any type: collection, file, chunk, etc.)"},{"in":"header","schema":{"$ref":"#/components/schemas/SwarmPostageBatchId"}
1,"name":"swarm-postage-batch-id","description":"Postage batch to use for re-upload. If none is provided and the file was uploaded on the same node before, it will re-use the same batch. If not found, it will return error. If a new batch is provided, the chunks are stamped again with the new batch."}],"responses":{"200":{"description":"Ok"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/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":"#/components/schemas/Addresses"}}}},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}}},"/health":{"get":{"summary":"Get node overall health Status","description":"Health Status will indicate node healthiness.\\n\\nIf node is unhealthy please check node logs for errors.\\n","tags":["Status"],"responses":{"200":{"description":"Health Status of node","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthStatus"}}}},"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":"#/components/responses/200"},"400":{"description":"Indicates that node is not ready","$ref":"#/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":"#/components/schemas/Balances"}}}},"500":{"$ref":"#/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":"#/components/schemas/SwarmAddress"},"required":true,"description":"Swarm address of peer"}],"responses":{"200":{"description":"Balance with the specific peer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Balance"}}}},"400":{"$ref":"#/components/responses/400"},"500":{"$ref":"#/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":"#/components/schemas/BlockListedPeers"}}}},"500":{"$ref":"#/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":"#/components/schemas/Balances"}}}},"500":{"$ref":"#/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":"#/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":"#/components/schemas/Balance"}}}},"400":{"$ref":"#/components/responses/400"},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}}},"/chequebook/address":{"get":{"summary":"Get the address of the chequebook contract used","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":["Chequebook"],"responses":{"200":{"description":"Ethereum address of chequebook contract","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChequebookAddress"}}}}}}},"/chequebook/balance":{"get":{"summary":"Get the balance of the chequebook","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":["Chequebook"],"responses":{"200":{"description":"Balance of the chequebook","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChequebookBalance"}}}},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}}},"/chunks/{address}":{"get":{"summary":"Get chunk","tags":["Chunk"],"parameters":[{"in":"path","name":"reference","schema":{"$ref":"#/components/schemas/SwarmReference"},"required":true,"description":"Swarm address of chunk"},{"in":"header","schema":{"$ref":"#/components/schemas/SwarmCache"},"name":"swarm-cache","required":false}],"responses":{"200":{"description":"Retrieved chunk content","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}},"head":{"summary":"Check if chunk at address exists locally","tags":["Chunk"],"parameters":[{"in":"path","name":"address","schema":{"$ref":"#/components/schemas/SwarmAddress"},"required":true,"description":"Swarm address of chunk"}],"responses":{"200":{"description":"Chunk exists"},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"default":{"description":"Default response"}}}},"/connect/{multiAddress}":{"post":{"summary":"Connect to address","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"],"parameters":[{"in":"path","allowReserved":true,"name":"multiAddress","schema":{"$ref":"#/components/schemas/
1MultiAddress"},"required":true,"description":"Underlay address of peer"}],"responses":{"200":{"description":"Returns overlay address of connected peer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Address"}}}},"400":{"$ref":"#/components/responses/400"},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}}},"/reservestate":{"get":{"summary":"Get reserve state","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":["Status"],"responses":{"200":{"description":"Reserve State","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReserveState"}}}},"default":{"description":"Default response"}}}},"/chainstate":{"get":{"summary":"Get chain state","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":["Status"],"responses":{"200":{"description":"Chain State","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChainState"}}}},"default":{"description":"Default response"}}}},"/node":{"get":{"summary":"Get information about the node","description":"This endpoint is available on the main API only if the node is spawned with the `--restricted` flag.","tags":["Status"],"responses":{"200":{"description":"Information about the node","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Node"}}}},"default":{"description":"Default response"}}}},"/peers":{"get":{"summary":"Get a list of 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 connected peers","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Peers"}}}},"default":{"description":"Default response"}}}},"/peers/{address}":{"delete":{"summary":"Remove 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":["Connectivity"],"parameters":[{"in":"path","name":"address","schema":{"$ref":"#/components/schemas/SwarmAddress"},"required":true,"description":"Swarm address of peer"}],"responses":{"200":{"description":"Disconnected peer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}},"400":{"$ref":"#/components/responses/400"},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}}},"/pingpong/{address}":{"post":{"summary":"Try connection to node","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"],"parameters":[{"in":"path","name":"address","schema":{"$ref":"#/components/schemas/SwarmAddress"},"required":true,"description":"Swarm address of peer"}],"responses":{"200":{"description":"Returns round trip time for given peer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RttMs"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}}},"/settlements/{address}":{"get":{"summary":"Get amount of sent and received from settlements with a 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":["Settlements"],"parameters":[{"in":"path","name":"address","schema":{"$ref":"#/components/schemas/SwarmAddress"},"required":true,"description":"Swarm address of peer"}],"responses":{"200":{"description":"Amount of sent or received from settlements with a peer","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Settlement"}}}},"400":{"$ref":"#/components/responses/400"},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}}},"/settlements":{"get":{"summary":"Get settlements with all known peers and total amount sent or received","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":["Settlements"],"responses":{"200":{"description":"Settlements with all known peers and total amount sent or received","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Settlements"}}}},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}}},"/timesettlements":{"get":{"summary":"Get time based settlements with all known peers and total amount sent or received","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":["Settlements"],"responses":{"200":{"description":"Time based settlements with all known peers and total amount sent or received","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Settlements"}}}},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}}},"/topology":{"get":{"summary":"Get topology of known network","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":"Swarm topology of the bee node","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BzzTopology"}}}}}}},"/welcome-message":{"get":{"summary":"Get configured P2P welcome message","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":"Welcome message","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WelcomeMessage"}}}},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}},"post":{"summary":"Set P2P welcome message","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"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WelcomeMessage"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthStatus"}}}},"400":{"$ref":"#/components/responses/400"},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}}},"/chequebook/cashout/{peer-id}":{"get":{"summary":"Get last cashout action for the 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":[]}],"parameters":[{"in":"path","name":"peer-id","schema":{"$ref":"#/components/schemas/SwarmAddress"},"required":true,"description":"Swarm address of peer"}],"tags":["Chequebook"],"responses":{"200":{"description":"Cashout status","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SwapCashoutStatus"}}}},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}},"post":{"summary":"Cashout the last cheque for the 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":[]}],"parameters":[{"in":"path","name":"peer-id","schema":{"$ref":"#/components/schemas/SwarmAddress"},"required":true,"description":"Swarm address of peer"},{"$ref":"#/components/parameters/GasPriceParameter"},{"$ref":"#/components/parameters/GasLimitParameter"}],"tags":["Chequebook"],"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionResponse"}}}},"404":{"$ref":"#/components/responses/404"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}}},"/chequebook/cheque/{peer-id}":{"get":{"summary":"Get last cheques for the 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":[]}],"parameters":[{"in":"path","name":"peer-id","schema":{"$ref":"#/components/schemas/SwarmAddress"},"required":true,"description":"Swarm address of peer"}],"tags":["Chequebook"],"responses":{"200":{"description":"Last cheques","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChequePeerResponse"}}}},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}}},"/chequebook/cheque":{"get":{"summary":"Get last cheques for all 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":["Chequebook"],"responses":{"200":{"description":"Last cheques","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChequeAllPeersResponse"}}}},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}}},"/chequebook/deposit":{"post":{"summary":"Deposit tokens from overlay address into chequebook","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":[]}],"parameters":[{"in":"query","name":"amount","schema":{"type":"integer"},"required":true,"description":"amount of tokens to deposit"},{"$ref":"#/components/parameters/GasPriceParameter"}],"tags":["Chequebook"],"responses":{"201":{"description":"Transaction hash of the deposit transaction","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionResponse"}}}},"400":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}}},"/chequebook/withdraw":{"post":{"summary":"Withdraw tokens from the chequebook to the overlay address","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":[]}],"parameters":[{"in":"query","name":"amount","schema":{"type":"integer"},"required":true,"description":"amount of tokens to withdraw"},{"$ref":"#/components/parameters/GasPriceParameter"}],"tags":["Chequebook"],"responses":{"201":{"description":"Transaction hash of the withdraw transaction","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionResponse"}}}},"400":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}}},"/transactions":{"get":{"summary":"Get list of pending transactions","description":"This endpoint is available on the main API only if the node is spawned with the `--restricted` flag.","tags":["Transaction"],"responses":{"200":{"description":"List of pending transactions","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PendingTransactionsResponse"}}}},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}}},"/transactions/{txHash}":{"get":{"summary":"Get information about a sent transaction","description":"This endpoint is available on the main API only if the node is spawned with the `--restricted` flag.","parameters":[{"in":"path","name":"txHash","schema":{"$ref":"#/components/schemas/TransactionHash"},"required":true,"description":"Hash of the transaction"}],"tags":["Transaction"],"responses":{"200":{"description":"Get info about transaction","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionInfo"}}}},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}},"post":{"summary":"Rebroadcast existing transaction","description":"This endpoint is available on the main API only if the node is spawned with the `--restricted` flag.","parameters":[{"in":"path","name":"txHash","schema":{"$ref":"#/components/schemas/TransactionHash"},"required":true,"description":"Hash of the transaction"}],"tags":["Transaction"],"responses":{"200":{"description":"Hash of the transaction","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionResponse"}}}},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}},"delete":{"summary":"Cancel existing transaction","description":"This endpoint is available on the main API only if the node is spawned with the `--restricted` flag.","parameters":[{"in":"path","name":"txHash","schema":{"$ref":"#/components/schemas/TransactionHash"},"required":true,"description":"Hash of the transaction"},{"$ref":"#/components/parameters/GasPriceParameter"}],"tags":["Transaction"],"responses":{"200":{"description":"Hash of the transaction","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TransactionResponse"}}}},"404":{"$ref":"#/components/responses/404"},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}}},"/stamps":{"get":{"summary":"Get stamps for this node","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":["Postage Stamps"],"responses":{"200":{"description":"Returns an array of postage batches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebugPostageBatchesResponse"}}}},"404":{"$ref":"#/components/responses/404"},"default":{"description":"Default response"}}}},"/stamps/{batch_id}":{"parameters":[{"in":"path","name":"batch_id","schema":{"$ref":"#/components/schemas/BatchID"},"required":true,"description":"Swarm address of the stamp"}
1],"get":{"summary":"Get an individual postage batch status","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":["Postage Stamps"],"responses":{"200":{"description":"Returns an individual postage batch state","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebugPostageBatch"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"default":{"description":"Default response"}}}},"/stamps/{batch_id}/buckets":{"parameters":[{"in":"path","name":"batch_id","schema":{"$ref":"#/components/schemas/BatchID"},"required":true,"description":"Swarm address of the stamp"}],"get":{"summary":"Get extended bucket data of a batch","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":["Postage Stamps"],"responses":{"200":{"description":"Returns extended bucket data of the provided batch ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostageStampBuckets"}}}},"400":{"$ref":"#/components/responses/400"},"404":{"$ref":"#/components/responses/404"},"default":{"description":"Default response"}}}},"/stamps/{amount}/{depth}":{"post":{"summary":"Buy a new postage batch.","security":[{"bearerAuth":[]}],"description":"Be aware, this endpoint creates an on-chain transactions and transfers BZZ from the node\'s Ethereum account and hence directly manipulates the wallet balance!\\n\\nThis endpoint is available on the main API only if the node is spawned with the `--restricted` flag along with a bearer authentication token.\\n","tags":["Postage Stamps"],"parameters":[{"in":"path","name":"amount","schema":{"$ref":"#/components/schemas/BigInt"},"required":true,"description":"Amount of BZZ added that the postage batch will have."},{"in":"path","name":"depth","schema":{"type":"integer"},"required":true,"description":"Batch depth which specifies how many chunks can be signed with the batch. It is a logarithm. Must be higher than default bucket depth (16)"},{"in":"query","name":"label","schema":{"type":"string"},"required":false,"description":"An optional label for this batch"},{"in":"header","name":"immutable","schema":{"type":"boolean"},"required":false},{"$ref":"#/components/parameters/GasPriceParameter"},{"$ref":"#/components/parameters/GasLimitParameter"}],"responses":{"201":{"description":"Returns the newly created postage batch ID","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchIDResponse"}}}},"400":{"$ref":"#/components/responses/400"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}}},"/stamps/topup/{batch_id}/{amount}":{"patch":{"summary":"Top up an existing postage batch.","description":"Be aware, this endpoint creates on-chain transactions and transfers BZZ from the node\'s Ethereum account and hence directly manipulates the wallet balance!\\n\\nThis endpoint is available on the main API only if the node is spawned with the `--restricted` flag along with a bearer authentication token.\\n","tags":["Postage Stamps"],"parameters":[{"in":"path","name":"batch_id","schema":{"$ref":"#/components/schemas/BatchID"},"required":true,"description":"Batch ID to top up"},{"in":"path","name":"amount","schema":{"type":"integer"},"required":true,"description":"Amount of BZZ per chunk to top up to an existing postage batch."},{"$ref":"#/components/parameters/GasPriceParameter"},{"$ref":"#/components/parameters/GasLimitParameter"}],"responses":{"202":{"description":"Returns the postage batch ID that was topped up","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchIDResponse"}}}},"400":{"$ref":"#/components/responses/400"},"402":{"$ref":"#/components/responses/402"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}}},"/stamps/dilute/{batch_id}/{depth}":{"patch":{"summary":"Dilute an existing postage batch.","description":"Be aware, this endpoint creates on-chain transactions and transfers BZZ from the node\'s Ethereum account and hence directly manipulates the wallet balance!\\n\\nThis endpoint is available on the main API only if the node is spawned with the `--restricted` flag along with a bearer authentication token.\\n","tags":["Postage Stamps"],"parameters":[{"in":"path","name":"batch_id","schema":{"$ref":"#/components/schemas/BatchID"},"required":true,"description":"Batch ID to dilute"},{"in":"path","name":"depth","schema":{"type":"integer"},"required":true,"description":"New batch depth. Must be higher than the previous depth."},{"$ref":"#/components/parameters/GasPriceParameter"},{"$ref":"#/components/parameters/GasLimitParameter"}],"responses":{"202":{"description":"Returns the postage batch ID that was diluted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchIDResponse"}}}},"400":{"$ref":"#/components/responses/400"},"429":{"$ref":"#/components/responses/429"},"500":{"$ref":"#/components/responses/500"},"default":{"description":"Default response"}}}},"/batches":{"get":{"summary":"Get all globally available batches that were purchased by all nodes.","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":["Postage Stamps"],"responses":{"200":{"description":"Returns an array of all available and currently valid postage batches.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebugPostageAllBatchesResponse"}}}},"default":{"description":"Default response"}}}}},"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"},"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"SecurityToken"}}
1,"schemas":{"SecurityTokenRequest":{"type":"object","properties":{"role":{"type":"string","nullable":false},"expiry":{"type":"integer","nullable":false,"description":"Expiration time in seconds"}}},"SecurityTokenResponse":{"type":"object","properties":{"key":{"type":"string","nullable":false}}},"ProblemDetails":{"type":"object","properties":{"code":{"type":"integer"},"message":{"type":"string"},"reasons":{"type":"array","nullable":true,"description":"List of reasons for the error message.","items":{"type":"string"}}}},"SwarmPostageBatchId":{"in":"header","name":"swarm-postage-batch-id","description":"ID of Postage Batch that is used to upload data with","required":true,"schema":{"$ref":"#/components/schemas/SwarmAddress"}},"SwarmTagParameter":{"in":"header","name":"swarm-tag","schema":{"$ref":"#/components/schemas/Uid"},"required":false,"description":"Associate upload with an existing Tag UID"},"SwarmPinParameter":{"in":"header","name":"swarm-pin","schema":{"type":"boolean"},"required":false,"description":"Represents if the uploaded data should be also locally pinned on the node.\\n"},"SwarmDeferredUpload":{"in":"header","name":"swarm-deferred-upload","schema":{"type":"boolean","default":"false"},"required":false,"description":"Determines if the uploaded data should be sent to the network immediately or in a deferred fashion. By default the upload will be direct.\\n"},"SwarmEncryptParameter":{"in":"header","name":"swarm-encrypt","schema":{"type":"boolean"},"required":false,"description":"Represents the encrypting state of the file\\n"},"SwarmRedundancyLevelParameter":{"in":"header","name":"swarm-redundancy-level","schema":{"type":"integer","enum":[0,1,2,3,4]},"required":false,"description":"Add redundancy to the data being uploaded so that downloaders can download it with better UX. 0 value is default and does not add any redundancy to the file.\\n"},"Uid":{"type":"integer"},"SwarmAddress":{"type":"string","pattern":"^[A-Fa-f0-9]{64}$","example":"36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"},"SwarmEncryptedReference":{"type":"string","pattern":"^[A-Fa-f0-9]{128}$","example":"36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f2d2810619d29b5dbefd5d74abce25d58b81b251baddb9c3871cf0d6967deaae2"},"DomainName":{"type":"string","pattern":"^[A-Za-z0-9]+\\\\.[A-Za-z0-9]+$","example":"swarm.eth"},"SwarmReference":{"oneOf":[{"$ref":"#/components/schemas/SwarmAddress"},{"$ref":"#/components/schemas/SwarmEncryptedReference"},{"$ref":"#/components/schemas/DomainName"}]},"ReferenceResponse":{"type":"object","properties":{"reference":{"$ref":"#/components/schemas/SwarmReference"}}},"Duration":{"description":"Go time.Duration format","type":"string","example":"5.0018ms"},"FileName":{"type":"string"},"DateTime":{"type":"string","format":"date-time","example":"2020-06-11T11:26:42.6969797+02:00"},"NewTagResponse":{"type":"object","properties":{"uid":{"$ref":"#/components/schemas/Uid"},"startedAt":{"$ref":"#/components/schemas/DateTime"},"split":{"type":"integer","description":"Number of chunks created by the splitter."},"seen":{"type":"integer","description":"Number of chunks that are already uploaded with same reference and same postage batch. These don\'t need to be synced again."},"stored":{"type":"integer","description":"Number of chunks that were stored locally as they lie in the uploader node\'s neighborhood. This is only applicable for full nodes."},"sent":{"type":"integer","description":"Number of chunks sent on the network to peers as a part of the upload. Chunks could be sent multiple times because of failures or replication."},"synced":{"type":"integer","description":"Number of chunks that were pushed with a valid receipt. The receipt will also show if they were stored at the correct depth."}}},"TagsList":{"type":"object","properties":{"tags":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/NewTagResponse"}}}},"NewTagRequest":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/SwarmAddress"}}},"Address":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/SwarmAddress"}}},"HealthStatus":{"type":"object","properties":{"status":{"type":"string","enum":["ok","nok"],"description":"Indicates health state of node * `ok` - node is healthy * `nok` - node is not healthy\\n"},"version":{"type":"string"},"apiVersion":{"type":"string","default":"0.0.0","description":"The default value is set in case the bee binary w
1as not build correctly."},"debugApiVersion":{"type":"string","default":"0.0.0","description":"The default value is set in case the bee binary was not build correctly."}}},"SwarmOnlyReference":{"oneOf":[{"$ref":"#/components/schemas/SwarmAddress"},{"$ref":"#/components/schemas/SwarmEncryptedReference"}]},"Response":{"type":"object","properties":{"message":{"type":"string"},"code":{"type":"integer"}}},"SwarmOnlyReferencesList":{"type":"object","properties":{"references":{"type":"array","nullable":false,"items":{"$ref":"#/components/schemas/SwarmOnlyReference"}}}},"PssTopic":{"type":"string"},"PssTargets":{"pattern":"^[0-9a-fA-F]{1,6}(,[0-9a-fA-F]{1,6})*$","description":"List of hex string targets that are comma seprated and can have maximum length of 6","type":"string"},"PssRecipient":{"type":"string"},"EthereumAddress":{"type":"string","pattern":"^[A-Fa-f0-9]{40}$","example":"36b7efd913ca4cf880b8eeac5093fa27b0825906"},"HexString":{"type":"string","pattern":"^([A-Fa-f0-9]+)$","example":"cf880b8eeac5093fa27b0825906c600685"},"FeedType":{"type":"string","pattern":"^(sequence|epoch)$"},"IsRetrievableResponse":{"type":"object","properties":{"isRetrievable":{"type":"boolean"}}},"P2PUnderlay":{"type":"string","example":"/ip4/127.0.0.1/tcp/1634/p2p/16Uiu2HAmTm17toLDaPYzRyjKn27iCB76yjKnJ5DjQXneFmifFvaX"},"PublicKey":{"type":"string","pattern":"^[A-Fa-f0-9]{66}$","example":"02ab7473879005929d10ce7d4f626412dad9fe56b0a6622038931d26bd79abf0a4"},"Addresses":{"type":"object","properties":{"overlay":{"$ref":"#/components/schemas/SwarmAddress"},"underlay":{"type":"array","items":{"$ref":"#/components/schemas/P2PUnderlay"}},"ethereum":{"$ref":"#/components/schemas/EthereumAddress"},"publicKey":{"$ref":"#/components/schemas/PublicKey"},"pssPublicKey":{"$ref":"#/components/schemas/PublicKey"}}},"BigInt":{"description":"Numeric string that represents integer which might exceeds `Number.MAX_SAFE_INTEGER` limit (2^53-1)","type":"string","example":"1000000000000000000"},"Balance":{"type":"object","properties":{"peer":{"$ref":"#/components/schemas/SwarmAddress"},"balance":{"$ref":"#/components/schemas/BigInt"}}},"Balances":{"type":"object","properties":{"balances":{"type":"array","items":{"$ref":"#/components/schemas/Balance"}}}},"BlockListedPeers":{"type":"array","items":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/Address"},"fullNode":{"type":"boolean"},"reason":{"type":"string"},"duration":{"type":"integer"}}}},"ChequebookAddress":{"type":"object","properties":{"chequebookAddress":{"$ref":"#/components/schemas/EthereumAddress"}}},"ChequebookBalance":{"type":"object","properties":{"totalBalance":{"$ref":"#/components/schemas/BigInt"},"availableBalance":{"$ref":"#/components/schemas/BigInt"}}},"SwarmCache":{"in":"header","name":"swarm-cache","schema":{"type":"boolean","default":"true"},"required":false,"description":"Determines if the download data should be cached on the node. By default the download will be cached"},"MultiAddress":{"type":"string"},"ReserveState":{"type":"object","properties":{"radius":{"type":"integer"},"storageRadius":{"type":"integer"},"commitment":{"type":"integer"}}},"ChainState":{"type":"object","properties":{"chainTip":{"type":"integer"},"block":{"type":"integer"},"totalAmount":{"$ref":"#/components/schemas/BigInt"},"currentPrice":{"$ref":"#/components/schemas/BigInt"}}},"Node":{"type":"object","properties":{"beeMode":{"type":"string","enum":["light","full","dev"],"description":"Gives back in what mode the Bee client has been started. The modes are mutually exclusive * `light` - light node; does not participate in forwarding or storing chunks * `full` - full node * `dev` - development mode; Bee client for development purposes, blockchain operations are mocked\\n"},"chequebookEnabled":{"type":"boolean"},"swapEnabled":{"type":"boolean"}}},"Peers":{"type":"object","properties":{"peers":{"type":"array","nullable":false,"items":{"$ref":"#/components/schemas/Address"}}}},"RttMs":{"type":"object","properties":{"rtt":{"$ref":"#/components/schemas/Duration"}}},"Settlement":{"type":"object","properties":{"peer":{"$ref":"#/components/schemas/SwarmAddress"},"received":{"type":"integer"},"sent":{"type":"integer"}}},"Settlements":{"type":"object","properties":{"totalReceived":{"type":"integer"},"totalSent":{"type":"integer"},"settlements":{"type":"array","nullable":false,"items":{"$ref":"#/components/schemas/Settlement"}}}},"PeerMetricsView":{"type":"object","properties":{"lastSeenTimestamp":{"type":"integer","nullable":false},"sessionConnectionRetry":{"type":"integer","nullable":false},"connectionTotalDuration":{"type":"number","nullable":false},"sessionConnectionDuration":{"type":"number","nullable":false},"sessionConnectionDirection":{"type":"string","nullable":false},"latencyEWMA":{"type":"integer","nullable":false}
1,"reachability":{"type":"string"},"healthy":{"type":"boolean"}}},"BzzTopology":{"type":"object","properties":{"baseAddr":{"$ref":"#/components/schemas/SwarmAddress"},"population":{"type":"integer"},"connected":{"type":"integer"},"timestamp":{"type":"string"},"nnLowWatermark":{"type":"integer"},"depth":{"type":"integer"},"reachability":{"type":"string","enum":["Unknown","Public","Private"]},"networkAvailability":{"type":"string","enum":["Unknown","Available","Unavailable"]},"bins":{"type":"object","additionalProperties":{"type":"object","properties":{"population":{"type":"integer"},"connected":{"type":"integer"},"disconnectedPeers":{"type":"array","items":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/SwarmAddress"},"metrics":{"$ref":"#/components/schemas/PeerMetricsView"}}}},"connectedPeers":{"type":"array","items":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/SwarmAddress"},"metrics":{"$ref":"#/components/schemas/PeerMetricsView"}}}}}}}}},"WelcomeMessage":{"type":"object","properties":{"welcomeMessage":{"type":"string"}}},"Cheque":{"type":"object","properties":{"beneficiary":{"$ref":"#/components/schemas/EthereumAddress"},"chequebook":{"$ref":"#/components/schemas/EthereumAddress"},"payout":{"$ref":"#/components/schemas/BigInt"}}},"TransactionHash":{"type":"string","pattern":"^0x[A-Fa-f0-9]{64}$","example":"0x780cb6a37d1946978087896e1e489c37e30fe3e329510fff8d97360f73529f5a"},"SwapCashoutResult":{"type":"object","properties":{"recipient":{"$ref":"#/components/schemas/EthereumAddress"},"lastPayout":{"$ref":"#/components/schemas/BigInt"},"bounced":{"type":"boolean"}}},"SwapCashoutStatus":{"type":"object","properties":{"peer":{"$ref":"#/components/schemas/SwarmAddress"},"lastCashedCheque":{"$ref":"#/components/schemas/Cheque"},"transactionHash":{"$ref":"#/components/schemas/TransactionHash"},"result":{"$ref":"#/components/schemas/SwapCashoutResult"},"uncashedAmount":{"$ref":"#/components/schemas/BigInt"}}},"GasPrice":{"description":"Gas price refers to the amount you\u2019re willing to pay for every unit of gas.","type":"integer"},"GasLimit":{"description":"Gas limit refers to the maximum amount of gas you\u2019re willing to spend on a particular transaction.","type":"integer","minimum":0,"maximum":18446744073709552000},"TransactionResponse":{"type":"object","properties":{"transactionHash":{"$ref":"#/components/schemas/TransactionHash"}}},"ChequePeerResponse":{"type":"object","properties":{"peer":{"$ref":"#/components/schemas/SwarmAddress"},"lastreceived":{"$ref":"#/components/schemas/Cheque"},"lastsent":{"$ref":"#/components/schemas/Cheque"}}},"ChequeAllPeersResponse":{"type":"object","properties":{"lastcheques":{"type":"array","nullable":false,"items":{"$ref":"#/components/schemas/ChequePeerResponse"}}}},"TransactionInfo":{"type":"object","properties":{"transactionHash":{"$ref":"#/components/schemas/TransactionHash"},"to":{"$ref":"#/components/schemas/EthereumAddress"},"nonce":{"type":"integer"},"gasPrice":{"$ref":"#/components/schemas/BigInt"},"gasLimit":{"type":"integer"},"gasTipCap":{"$ref":"#/components/schemas/BigInt"},"gasTipBoost":{"type":"integer"},"gasFeeCap":{"$ref":"#/components/schemas/BigInt"},"data":{"type":"string"},"created":{"$ref":"#/components/schemas/DateTime"},"description":{"type":"string"},"value":{"$ref":"#/components/schemas/BigInt"}}},"PendingTransactionsResponse":{"type":"object","properties":{"pendingTransactions":{"type":"array","nullable":false,"items":{"$ref":"#/components/schemas/TransactionInfo"}}}},"BatchID":{"type":"string","pattern":"^[A-Fa-f0-9]{64}$","example":"36b7efd913ca4cf880b8eeac5093fa27b0825906c600685b6abdd6566e6cfe8f"},"PostageBatch":{"type":"object","properties":{"batchID":{"$ref":"#/components/schemas/BatchID"},"utilization":{"type":"integer"},"usable":{"description":"Indicate that the batch was discovered by the Bee node, but it awaits enough on-chain confirmations before declaring the batch as usable.","type":"boolean"},"label":{"type":"string"},"depth":{"type":"integer"},"amount":{"$ref":"#/components/schemas/BigInt"},"bucketDepth":{"type":"integer"},"blockNumber":{"type":"integer"},"immutableFlag":{"type":"boolean"},"exists":{"type":"boolean"},"batchTTL":{"type":"integer"}}},"PostageBatchNoIssuer":{"type":"object","properties":{"batchID":{"$ref":"#/components/schemas/BatchID"},"exists":{"type":"boolean"},"batchTTL":{"type":"integer"}}},"DebugPostageBatch":{"anyOf":[{"$ref":"#/components/schemas/PostageBatch"},{"$ref":"#/components/schemas/PostageBatchNoIssuer"}]},"DebugPostageBatchesResponse":{"type":"object","properties":{"stamps":{"type":"array","nullable":false,"items":{"$ref":"#/components/schemas/DebugPostageBatch"}}}},"StampBucketData":{"type":"object","properties":{"bucketID":{"type":"integer"},"collisions":{"type":"integer"}}},"PostageStampBuckets":{"type":"object","properties":{"depth":{"type":"integer"},"bucketDepth":{"type":"integer"},"bucketUpperBound":{"type":"integer"},"buckets":{"type":"array","nullable":false,"items":{"$ref":"#/components/schemas/StampBucketData"}}}},"BatchIDResponse":{"type":"object","properties":{"batchID":{"$ref":"#/components/schemas/BatchID"},"txHash":{"$ref":"#/components/schemas/TransactionHash"}}},"PostageBatchShort":{"type":"object","properties":{"batchID":{"$ref":"#/components/schemas/BatchID"},"value":{"$ref":"#/components/schemas/BigInt"},"start":{"type":"integer"},"depth":{"type":"integer"},"bucketDepth":{"type":"integer"},"immutableFlag":{"type":"boolean"},"batchTTL":{"type":"integer"},"owner":{"$ref":"#/components/schemas/EthereumAddress"},"storageRadius":{"type":"integer"}}},"DebugPostageAllBatchesResponse":{"type":"object","properties":{"batches":{"type":"array","nullable":false,"items":{"$ref":"#/components/schemas/PostageBatchShort"}}}}},"responses":{"200":{"description":"OK."},"204":{"description":"The resource was deleted successfully."},"400":{"description":"Bad request","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"401":{"description":"Unauthorized","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"402":{"description":"Payment Required","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"404":{"description":"Not Found","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Too many requests","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"500":{"description":"Internal Server Error","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}},"headers":{"SwarmTag":{"description":"Tag UID","schema":{"$ref":"#/components/schemas/Uid"}},"ETag":{"description":"The RFC7232 ETag header field in a response provides the current entity-\\ntag for the selected resource. An entity-tag is an opaque identifier for\\ndifferent versions of a resource over time, regardless whether multiple\\nversions are valid at the same time. An entity-tag consists of an opaque\\nquoted string, possibly prefixed by a weakness indicator.\\n","schema":{"type":"string"}},"SwarmFeedIndex":{"description":"The index of the found update","schema":{"$ref":"#/components/schemas/HexString"}},"SwarmFeedIndexNext":{"description":"The index of the next possible update","schema":{"$ref":"#/components/schemas/HexString"}}},"parameters":{"SwarmCache":{"in":"header","name":"swarm-cache","schema":{"type":"boolean","default":"true"},"required":false,"description":"Determines if the download data should be cached on the node. By default the download will be cached"}
1,"SwarmRedundancyStrategyParameter":{"in":"header","name":"swarm-redundancy-strategy","schema":{"type":"integer","enum":[0,1,2,3]},"required":false,"description":"Specify the retrieve strategy on redundant data. The numbers stand for NONE, DATA, PROX and RACE, respectively. Strategy NONE means no prefetching takes place. Strategy DATA means only data chunks are prefetched. Strategy PROX means only chunks that are close to the node are prefetched. Strategy RACE means all chunks are prefetched: n data chunks and k parity chunks. The first n chunks to arrive are used to reconstruct the file. Multiple strategies can be used in a fallback cascade if the swarm redundancy fallback mode is set to true. The default strategy is NONE, DATA, falling back to PROX, falling back to RACE\\n"},"SwarmRedundancyFallbackModeParameter":{"in":"header","name":"swarm-redundancy-fallback-mode","schema":{"type":"boolean"},"required":false,"description":"Specify if the retrieve strategies (chunk prefetching on redundant data) are used in a fallback cascade. The default is true.\\n"},"SwarmChunkRetrievalTimeoutParameter":{"in":"header","name":"swarm-chunk-retrieval-timeout","schema":{"$ref":"#/components/schemas/Duration"},"required":false,"description":"Specify the timeout for chunk retrieval. The default is 30 seconds.\\n"},"SwarmTagParameter":{"in":"header","name":"swarm-tag","schema":{"$ref":"#/components/schemas/Uid"},"required":false,"description":"Associate upload with an existing Tag UID"},"SwarmPostageBatchId":{"in":"header","name":"swarm-postage-batch-id","description":"ID of Postage Batch that is used to upload data with","required":true,"schema":{"$ref":"#/components/schemas/SwarmAddress"}},"SwarmPinParameter":{"in":"header","name":"swarm-pin","schema":{"type":"boolean"},"required":false,"description":"Represents if the uploaded data should be also locally pinned on the node.\\n"},"SwarmEncryptParameter":{"in":"header","name":"swarm-encrypt","schema":{"type":"boolean"},"required":false,"description":"Represents the encrypting state of the file\\n"},"ContentTypePreserved":{"in":"header","name":"Content-Type","schema":{"type":"string"},"description":"The specified content-type is preserved for download of the asset"},"SwarmCollection":{"in":"header","name":"swarm-collection","schema":{"type":"boolean"},"required":false,"description":"Upload file/files as a collection"},"SwarmIndexDocumentParameter":{"in":"header","name":"swarm-index-document","schema":{"type":"string","example":"index.html"},"required":false,"description":"Default file to be referenced on path, if exists under that path"},"SwarmErrorDocumentParameter":{"in":"header","name":"swarm-error-document","schema":{"type":"string","example":"error.html"},"required":false,"description":"Configure custom error document to be returned when a specified path can not be found in collection"},"SwarmDeferredUpload":{"in":"header","name":"swarm-deferred-upload","schema":{"type":"boolean","default":"false"},"required":false,"description":"Determines if the uploaded data should be sent to the network immediately or in a deferred fashion. By default the upload will be direct.\\n"},"SwarmRedundancyLevelParameter":{"in":"header","name":"swarm-redundancy-level","schema":{"type":"integer","enum":[0,1,2,3,4]},"required":false,"description":"Add redundancy to the data being uploaded so that downloaders can download it with better UX. 0 value is default and does not add any redundancy to the file.\\n"},"GasPriceParameter":{"in":"header","name":"gas-price","schema":{"$ref":"#/components/schemas/GasPrice"},"required":false,"description":"Gas price for transaction"},"GasLimitParameter":{"in":"header","name":"gas-limit","schema":{"$ref":"#/components/schemas/GasLimit"},"required":false,"description":"Gas limit for transaction"}}}}}')}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.