opensource/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2025-06-20 19:19:06 +08:00
Code Issues Projects Releases Wiki Activity

docs: add some minimal read-only API documentation

Browse Source 
fixes #5436

License: MIT
Signed-off-by: Steven Allen <steven@stebalien.com>
This commit is contained in:
Steven Allen
2018-09-06 17:47:11 -07:00
parent bdbb63db85
commit f21b4cd30a
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/gateway.md
View File

@ -46,3 +46,14 @@ your query string to explicitly specify the filename. For example:
## MIME-Types
TODO
## Read-Only API
For convenience, the gateway exposes a read-only API. This read-only API exposes
a read-only, "safe" subset of the normal API.
For example, you use this to download a block:
```
> curl https://ipfs.io/api/v0/block/get/zb2rhi36Gc9GJWijLEL6zW45MBux5FcFv5gJmjXA7VAMozEXY
```