Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add some minimal read-only API documentation #5437

Merged
merged 1 commit into from
Sep 7, 2018
Merged

docs: add some minimal read-only API documentation #5437

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions docs/gateway.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```