api

Documentation

Index

• type API
  • func New(data *data.Data, metrics *metrics.Metrics, version string) *API
  • func (a *API) Open() error
  • func (a *API) SetMasterkey(key []byte)
  • func (a *API) Start(serverID, apiPort string, tlsCertificate, tlsKey, tlsCACert string, ...) error

Types

type API

type API struct {
	// contains filtered or unexported fields
}

API holds the API endpoints for the tool

func New

func New(data *data.Data, metrics *metrics.Metrics, version string) *API

New returns the API struct filled with the required objects and configuration

func (*API) Open

func (a *API) Open() error

Open the database with the current information

func (*API) SetMasterkey

func (a *API) SetMasterkey(key []byte)

SetMasterkey sets the key on the data struct

func (*API) Start

func (a *API) Start(serverID, apiPort string, tlsCertificate, tlsKey, tlsCACert string, logger *logging.Logging) error

Start initiates the API server and blocks server execution