api

Documentation

Index

• type Api
  • func (a *Api) Addr() string
  • func (a *Api) Run()
  • func (a *Api) Start(addr string, serveDocs bool)
  • func (a *Api) Stop() error
• type SubsystemInfo

Types

type Api

type Api struct {
	Node     *core.Textile
	Bots     *bots.Service
	PinCode  string
	RepoPath string
	// contains filtered or unexported fields
}

Gateway is a HTTP API for getting files and links from IPFS

var Host *Api

Host is the instance used by the daemon

func (*Api) Addr

func (a *Api) Addr() string

Addr returns the api address

func (*Api) Run

func (a *Api) Run()

@securityDefinitions.basic BasicAuth @Security BasicAuth @BasePath /api/v0

func (*Api) Start

func (a *Api) Start(addr string, serveDocs bool)

Start starts the host instance

func (*Api) Stop

func (a *Api) Stop() error

Stop stops the http api

type SubsystemInfo

type SubsystemInfo map[string]string