coosld/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2026-02-21 18:37:45 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Merge pull request #5437 from ipfs/fix/5436

Browse Source 
docs: add some minimal read-only API documentation
This commit is contained in:
Steven Allen 2018-09-07 17:38:36 +00:00 committed by GitHub
commit 61641fe3e9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 11 additions and 0 deletions
Show Stats 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
```