netbox

Documentation

Index

• type APIManyResponse
• type APIRequestClient
• type APIResultModel
• type Record
  • func GetRecordsQuery(requestClient *APIRequestClient, query *RecordQuery) ([]Record, error)
• type RecordQuery
  • func (recordQuery *RecordQuery) Encode() string
• type SOAMName
• type Zone
  • func GetZones(requestClient *APIRequestClient) ([]Zone, error)

Types

type APIManyResponse

type APIManyResponse[T APIResultModel] struct {
	Count    int    `json:"count"`
	Next     string `json:"next"`
	Previous string `json:"previous"`
	Results  []T    `json:"results"`
}

type APIRequestClient

type APIRequestClient struct {
	Client    *http.Client
	NetboxURL *url.URL
	Token     string
	UserAgent string
}

type APIResultModel

type APIResultModel interface {
	Record | Zone
}

type Record

type Record struct {
	Type  string  `json:"type"`
	Value string  `json:"value"`
	TTL   *uint32 `json:"ttl"`
	Zone  Zone    `json:"zone"`
	FQDN  string  `json:"fqdn"`
}

func GetRecordsQuery

func GetRecordsQuery(
	requestClient *APIRequestClient,
	query *RecordQuery,
) ([]Record, error)

type RecordQuery

type RecordQuery struct {
	FQDN string
	Name string
	Type []string
	Zone *Zone
}

func (*RecordQuery) Encode

func (recordQuery *RecordQuery) Encode() string

type SOAMName

type SOAMName struct {
	Name string `json:"name"`
}

type Zone

type Zone struct {
	DefaultTTL  uint32     `json:"default_ttl"`
	ID          int        `json:"id"`
	Name        string     `json:"name"`
	NameServers []SOAMName `json:"nameservers"`
}

func GetZones

func GetZones(requestClient *APIRequestClient) ([]Zone, error)