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.

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

Read-only API #1383

Closed
2 tasks
jbenet opened this issue Jun 17, 2015 · 3 comments
Closed
2 tasks

Read-only API #1383

jbenet opened this issue Jun 17, 2015 · 3 comments

Comments

@jbenet
Copy link
Member

jbenet commented Jun 17, 2015

Many use cases (eg. #1322) would love an exposed read-only API, in particular through the gateway.

We can do this a few different ways:

  1. mount the readonly API on the normal Gateway endpoint (my preference) (easy)
  2. create another, isolated endpoint for a readonly API. (medium)
  3. implement auth on the API for writable commands, and open that up. (hard)

Regardless, when exposing these, we should expose:

  • mainly read-only things that serve IPFS content {cat, ls, refs, block {get, stat}, object {get, stat, links}}
  • maybe expose internal node service state (e.g. {stats, bitswap, dht, id})
  • do not expose internal node variables (e.g. pins, keys, etc).

Short term goals

if we go with (1.) above, let's:

  • setup gateway to expose pieces of the API
  • expose {cat, ls, refs, block {get, stat}, object {get, stat, links}} via gateway
@harlantwood
Copy link
Contributor

+1 for option 1.

@Kubuxu
Copy link
Member

Kubuxu commented May 15, 2016

This is already resolved, isn't it? API is accessible under RO gateway localhost:8080.

@harlantwood
Copy link
Contributor

Yup, should be closed I believe.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants