api

Documentation

Overview

@BasePath /api/

Index

• Constants
• type BlockingStatus
• type QueryRequest
• type QueryResult

Constants

const (
	BlockingStatusPath  = "/api/blocking/status"
	BlockingEnablePath  = "/api/blocking/enable"
	BlockingDisablePath = "/api/blocking/disable"
	BlockingQueryPath   = "/api/query"
)

Types

type BlockingStatus

type BlockingStatus struct {
	// True if blocking is enabled
	Enabled bool `json:"enabled"`
	// If blocking is temporary disabled: amount of seconds until blocking will be enabled
	AutoEnableInSec uint `json:"autoEnableInSec"`
}

type QueryRequest

type QueryRequest struct {
	// query for DNS request
	Query string
	// request type (A, AAAA, ...)
	Type string
}

type QueryResult

type QueryResult struct {
	// blocky reason for resolution
	Reason string `json:"reason"`
	// response type (CACHED, BLOCKED, ...)
	ResponseType string `json:"responseType"`
	// actual DNS response
	Response string `json:"response"`
	// DNS return code (NOERROR, NXDOMAIN, ...)
	ReturnCode string `json:"returnCode"`
}