api

Documentation

Overview

Package api implements the HTTP API used for the Grafana Agent Flow UI.

The API is internal only; it is not stable and shouldn't be relied on externally.

Index

• type FlowAPI
  • func NewFlowAPI(flow service.Host) *FlowAPI
  • func (f *FlowAPI) RegisterRoutes(urlPrefix string, r *mux.Router)

Types

type FlowAPI

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

FlowAPI is a wrapper around the component API.

func NewFlowAPI

func NewFlowAPI(flow service.Host) *FlowAPI

NewFlowAPI instantiates a new Flow API.

func (*FlowAPI) RegisterRoutes

func (f *FlowAPI) RegisterRoutes(urlPrefix string, r *mux.Router)

RegisterRoutes registers all the API's routes.