routes

package

v0.0.76 Latest Latest Go to latest Published: Jul 10, 2022 License: AGPL-3.0 Imports: 13 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/packetframe/api

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func AdminUserGroupAdd(c *fiber.Ctx) error
func AdminUserGroupRemove(c *fiber.Ctx) error
func AdminUserImpersonate(c *fiber.Ctx) error
func AdminUserList(c *fiber.Ctx) error
func Document() string
func MonitorTargets(c *fiber.Ctx) error
func RecordAdd(c *fiber.Ctx) error
func RecordDelete(c *fiber.Ctx) error
func RecordList(c *fiber.Ctx) error
func RecordUpdate(c *fiber.Ctx) error
func Register(app *fiber.App, meta map[string]interface{})
func UserChangePassword(c *fiber.Ctx) error
func UserConfirmPasswordReset(c *fiber.Ctx) error
func UserDelete(c *fiber.Ctx) error
func UserInfo(c *fiber.Ctx) error
func UserLogin(c *fiber.Ctx) error
func UserLogout(c *fiber.Ctx) error
func UserRequestPasswordReset(c *fiber.Ctx) error
func UserSignup(c *fiber.Ctx) error
func ZoneAdd(c *fiber.Ctx) error
func ZoneDelete(c *fiber.Ctx) error
func ZoneList(c *fiber.Ctx) error
func ZoneUserAdd(c *fiber.Ctx) error
func ZoneUserDelete(c *fiber.Ctx) error
type Resp
type Target

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	SMTPHost string
	SMTPUser string
	SMTPPass string
)

View Source

var Database *gorm.DB

Database stores the global database for the API

View Source

var Suffixes []string

Functions ¶

func AdminUserGroupAdd ¶

func AdminUserGroupAdd(c *fiber.Ctx) error

AdminUserGroupAdd handles a PUT request to add a group to a user

func AdminUserGroupRemove ¶

func AdminUserGroupRemove(c *fiber.Ctx) error

AdminUserGroupRemove handles a DELETE request to remove a group from a user

func AdminUserImpersonate ¶

func AdminUserImpersonate(c *fiber.Ctx) error

AdminUserImpersonate handles a POST request to log in as another user

func AdminUserList ¶

func AdminUserList(c *fiber.Ctx) error

AdminUserList handles a GET request to list all users

func Document ¶

func Document() string

Document generates a markdown table of API routes

func MonitorTargets ¶ added in v0.0.39

func MonitorTargets(c *fiber.Ctx) error

MonitorTargets handles a GET request to get node target status

func RecordAdd ¶

func RecordAdd(c *fiber.Ctx) error

RecordAdd handles a POST request to add a DNS record

func RecordDelete ¶

func RecordDelete(c *fiber.Ctx) error

RecordDelete handles a DELETE request to delete a DNS record

func RecordList ¶

func RecordList(c *fiber.Ctx) error

RecordList handles a GET request to list records for a zone

func RecordUpdate ¶

func RecordUpdate(c *fiber.Ctx) error

RecordUpdate handles a PUT request to update a DNS record

func Register ¶

func Register(app *fiber.App, meta map[string]interface{})

Register registers route handlers

func UserChangePassword ¶

func UserChangePassword(c *fiber.Ctx) error

UserChangePassword handles a POST request to change a user's password

func UserConfirmPasswordReset ¶ added in v0.0.41

func UserConfirmPasswordReset(c *fiber.Ctx) error

UserConfirmPasswordReset handles a POST request to change a user's password

func UserDelete ¶

func UserDelete(c *fiber.Ctx) error

UserDelete handles a DELETE request to delete a user

func UserInfo ¶

func UserInfo(c *fiber.Ctx) error

UserInfo handles a GET request to get a user's info

func UserLogin ¶

func UserLogin(c *fiber.Ctx) error

UserLogin handles a login POST request

func UserLogout ¶

func UserLogout(c *fiber.Ctx) error

UserLogout handles a GET request to log the user out

func UserRequestPasswordReset ¶ added in v0.0.41

func UserRequestPasswordReset(c *fiber.Ctx) error

UserRequestPasswordReset handles a POST request to request a password reset

func UserSignup ¶

func UserSignup(c *fiber.Ctx) error

UserSignup handles a signup POST request

func ZoneAdd ¶

func ZoneAdd(c *fiber.Ctx) error

ZoneAdd handles a POST request to add a zone

func ZoneDelete ¶

func ZoneDelete(c *fiber.Ctx) error

ZoneDelete handles a DELETE request to delete a zone

func ZoneList ¶

func ZoneList(c *fiber.Ctx) error

ZoneList handles a GET request to list zones for a user

func ZoneUserAdd ¶

func ZoneUserAdd(c *fiber.Ctx) error

ZoneUserAdd handles a PUT request to add a user to a zone

func ZoneUserDelete ¶

func ZoneUserDelete(c *fiber.Ctx) error

ZoneUserDelete handles a DELETE request to remove a user from a zone

Types ¶

type Resp ¶ added in v0.0.39

type Resp struct {
	Status string `json:"status"`
	Data   struct {
		ActiveTargets  []Target `json:"activeTargets"`
		DroppedTargets []Target `json:"droppedTargets"`
	} `json:"data"`
}

type Target ¶ added in v0.0.39

type Target struct {
	DiscoveredLabels struct {
		Address        string `json:"__address__"`
		MetricsPath    string `json:"__metrics_path__"`
		Scheme         string `json:"__scheme__"`
		ScrapeInterval string `json:"__scrape_interval__"`
		ScrapeTimeout  string `json:"__scrape_timeout__"`
		Job            string `json:"job"`
		Node           string `json:"node,omitempty"`
	} `json:"discoveredLabels"`
	Labels struct {
		Instance string `json:"instance"`
		Job      string `json:"job"`
		Node     string `json:"node,omitempty"`
	} `json:"labels"`
	ScrapePool         string    `json:"scrapePool"`
	ScrapeUrl          string    `json:"scrapeUrl"`
	GlobalUrl          string    `json:"globalUrl"`
	LastError          string    `json:"lastError"`
	LastScrape         time.Time `json:"lastScrape"`
	LastScrapeDuration float64   `json:"lastScrapeDuration"`
	Health             string    `json:"health"`
	ScrapeInterval     string    `json:"scrapeInterval"`
	ScrapeTimeout      string    `json:"scrapeTimeout"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL