apitype

Documentation

Overview

Package apitype contains types for the Tailscale LocalAPI and control plane API.

Index

• Constants
• type DNSConfig
• type DNSResolver
• type FileTarget
• type WaitingFile
• type WhoIsResponse

Constants

const LocalAPIHost = "local-tailscaled.sock"

LocalAPIHost is the Host header value used by the LocalAPI.

Types

type DNSConfig

type DNSConfig struct {
	Resolvers         []DNSResolver            `json:"resolvers"`
	FallbackResolvers []DNSResolver            `json:"fallbackResolvers"`
	Routes            map[string][]DNSResolver `json:"routes"`
	Domains           []string                 `json:"domains"`
	Nameservers       []string                 `json:"nameservers"`
	Proxied           bool                     `json:"proxied"`
}

type DNSResolver

type DNSResolver struct {
	Addr                string   `json:"addr"`
	BootstrapResolution []string `json:"bootstrapResolution,omitempty"`
}

type FileTarget

type FileTarget struct {
	Node *tailcfg.Node

	// PeerAPI is the http://ip:port URL base of the node's PeerAPI,
	// without any path (not even a single slash).
	PeerAPIURL string
}

FileTarget is a node to which files can be sent, and the PeerAPI URL base to do so via.

type WaitingFile

type WaitingFile struct {
	Name string
	Size int64
}

type WhoIsResponse

type WhoIsResponse struct {
	Node        *tailcfg.Node
	UserProfile *tailcfg.UserProfile

	// Caps are extra capabilities that the remote Node has to this node.
	Caps []string `json:",omitempty"`
}

WhoIsResponse is the JSON type returned by tailscaled debug server's /whois?ip=$IP handler.