Documentation
¶
Index ¶
- Constants
- type Autoprimary
- type CacheFlushResult
- type Comment
- type ConfigSetting
- type Cryptokey
- type Error
- type MapStatisticItem
- type Metadata
- type RRSet
- type Record
- type RingStatisticItem
- type SearchResult
- type SearchResultComment
- type SearchResultRecord
- type SearchResultZone
- type SearchResults
- type Server
- type Servers
- type SimpleStatisticItem
- type StatisticItem
- type TSIGKey
- type Zone
- type Zones
Constants ¶
const ( // CryptokeyKeytypeKsk captures enum value "ksk" CryptokeyKeytypeKsk string = "ksk" // CryptokeyKeytypeZsk captures enum value "zsk" CryptokeyKeytypeZsk string = "zsk" // CryptokeyKeytypeCsk captures enum value "csk" CryptokeyKeytypeCsk string = "csk" )
const ( // ZoneKindNative captures enum value "Native" ZoneKindNative string = "Native" // ZoneKindMaster captures enum value "Master" ZoneKindMaster string = "Master" // ZoneKindSlave captures enum value "Slave" ZoneKindSlave string = "Slave" )
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Autoprimary ¶
type Autoprimary struct {
// Account name for the autoprimary server
Account string `json:"account,omitempty"`
// IP address of the autoprimary server
IP string `json:"ip,omitempty"`
// DNS name of the autoprimary server
Nameserver string `json:"nameserver,omitempty"`
}
Autoprimary Autoprimary server
An autoprimary server that can provision new domains.
swagger:model Autoprimary
func (*Autoprimary) ContextValidate ¶
ContextValidate validates this autoprimary based on context it is used
func (*Autoprimary) MarshalBinary ¶
func (m *Autoprimary) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*Autoprimary) UnmarshalBinary ¶
func (m *Autoprimary) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type CacheFlushResult ¶
type CacheFlushResult struct {
// Amount of entries flushed
Count float64 `json:"count,omitempty"`
// A message about the result like "Flushed cache"
Result string `json:"result,omitempty"`
}
CacheFlushResult CacheFlushResult
The result of a cache-flush ¶
swagger:model CacheFlushResult
func (*CacheFlushResult) ContextValidate ¶
ContextValidate validates this cache flush result based on context it is used
func (*CacheFlushResult) MarshalBinary ¶
func (m *CacheFlushResult) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*CacheFlushResult) UnmarshalBinary ¶
func (m *CacheFlushResult) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Comment ¶
type Comment struct {
// Name of an account that added the comment
Account string `json:"account,omitempty"`
// The actual comment
Content string `json:"content,omitempty"`
// Timestamp of the last change to the comment
ModifiedAt int64 `json:"modified_at,omitempty"`
}
Comment Comment
A comment about an RRSet.
swagger:model Comment
func (*Comment) ContextValidate ¶
ContextValidate validates this comment based on context it is used
func (*Comment) MarshalBinary ¶
MarshalBinary interface implementation
func (*Comment) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type ConfigSetting ¶
type ConfigSetting struct {
// set to "ConfigSetting"
Name string `json:"name,omitempty"`
// The name of this setting (e.g. ‘webserver-port’)
Type string `json:"type,omitempty"`
// The value of setting name
Value string `json:"value,omitempty"`
}
ConfigSetting ConfigSetting
swagger:model ConfigSetting
func (*ConfigSetting) ContextValidate ¶
ContextValidate validates this config setting based on context it is used
func (*ConfigSetting) MarshalBinary ¶
func (m *ConfigSetting) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*ConfigSetting) UnmarshalBinary ¶
func (m *ConfigSetting) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Cryptokey ¶
type Cryptokey struct {
// Whether or not the key is in active use
Active bool `json:"active,omitempty"`
// The name of the algorithm of the key, should be a mnemonic
Algorithm string `json:"algorithm,omitempty"`
// The size of the key
Bits int64 `json:"bits,omitempty"`
// An array of DS records for this key, filtered by CDS publication settings
Cds []string `json:"cds"`
// The DNSKEY record for this key
Dnskey string `json:"dnskey,omitempty"`
// An array of DS records for this key
Ds []string `json:"ds"`
// The internal identifier, read only
ID int64 `json:"id,omitempty"`
// keytype
// Enum: [ksk zsk csk]
Keytype string `json:"keytype,omitempty"`
// The private key in ISC format
Privatekey string `json:"privatekey,omitempty"`
// Whether or not the DNSKEY record is published in the zone
Published bool `json:"published,omitempty"`
// set to "Cryptokey"
Type string `json:"type,omitempty"`
}
Cryptokey Cryptokey
Describes a DNSSEC cryptographic key ¶
swagger:model Cryptokey
func (*Cryptokey) ContextValidate ¶
ContextValidate validates this cryptokey based on context it is used
func (*Cryptokey) MarshalBinary ¶
MarshalBinary interface implementation
func (*Cryptokey) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Error ¶
type Error struct {
// A human readable error message
// Required: true
Error *string `json:"error"`
// Optional array of multiple errors encountered during processing
Errors []string `json:"errors"`
}
Error Error
Returned when the server encounters an error, either in client input or internally ¶
swagger:model Error
func (*Error) ContextValidate ¶
ContextValidate validates this error based on context it is used
func (*Error) MarshalBinary ¶
MarshalBinary interface implementation
func (*Error) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type MapStatisticItem ¶
type MapStatisticItem struct {
// Item name
Name string `json:"name,omitempty"`
// Set to "MapStatisticItem"
Type string `json:"type,omitempty"`
// Named values
Value []*SimpleStatisticItem `json:"value"`
}
MapStatisticItem MapStatisticItem
swagger:model MapStatisticItem
func (*MapStatisticItem) ContextValidate ¶
ContextValidate validate this map statistic item based on the context it is used
func (*MapStatisticItem) MarshalBinary ¶
func (m *MapStatisticItem) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*MapStatisticItem) UnmarshalBinary ¶
func (m *MapStatisticItem) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type Metadata ¶
type Metadata struct {
// Name of the metadata
Kind string `json:"kind,omitempty"`
// Array with all values for this metadata kind.
Metadata []string `json:"metadata"`
}
Metadata Metadata
Represents zone metadata ¶
swagger:model Metadata
func (*Metadata) ContextValidate ¶
ContextValidate validates this metadata based on context it is used
func (*Metadata) MarshalBinary ¶
MarshalBinary interface implementation
func (*Metadata) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type RRSet ¶
type RRSet struct {
// MUST be added when updating the RRSet. Must be REPLACE or DELETE. With DELETE, all existing RRs matching name and type will be deleted, including all comments. With REPLACE: when records is present, all existing RRs matching name and type will be deleted, and then new records given in records will be created. If no records are left, any existing comments will be deleted as well. When comments is present, all existing comments for the RRs matching name and type will be deleted, and then new comments given in comments will be created.
// Required: true
Changetype *string `json:"changetype"`
// List of Comment. Must be empty when changetype is set to DELETE. An empty list results in deletion of all comments. modified_at is optional and defaults to the current server time.
Comments []*Comment `json:"comments"`
// Name for record set (e.g. “www.powerdns.com.”)
// Required: true
Name *string `json:"name"`
// All records in this RRSet. When updating Records, this is the list of new records (replacing the old ones). Must be empty when changetype is set to DELETE. An empty list results in deletion of all records (and comments).
// Required: true
Records []*Record `json:"records"`
// DNS TTL of the records, in seconds. MUST NOT be included when changetype is set to “DELETE”.
// Required: true
TTL *int64 `json:"ttl"`
// Type of this record (e.g. “A”, “PTR”, “MX”)
// Required: true
Type *string `json:"type"`
}
RRSet RRSet
This represents a Resource Record Set (all records with the same name and type).
swagger:model RRSet
func (*RRSet) ContextValidate ¶
ContextValidate validate this r r set based on the context it is used
func (*RRSet) MarshalBinary ¶
MarshalBinary interface implementation
func (*RRSet) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Record ¶
type Record struct {
// The content of this record
// Required: true
Content *string `json:"content"`
// Whether or not this record is disabled. When unset, the record is not disabled
Disabled bool `json:"disabled,omitempty"`
}
Record Record
The RREntry object represents a single record.
swagger:model Record
func (*Record) ContextValidate ¶
ContextValidate validates this record based on context it is used
func (*Record) MarshalBinary ¶
MarshalBinary interface implementation
func (*Record) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type RingStatisticItem ¶
type RingStatisticItem struct {
// Item name
Name string `json:"name,omitempty"`
// Ring size
Size int64 `json:"size,omitempty"`
// Set to "RingStatisticItem"
Type string `json:"type,omitempty"`
// Named values
Value []*SimpleStatisticItem `json:"value"`
}
RingStatisticItem RingStatisticItem
swagger:model RingStatisticItem
func (*RingStatisticItem) ContextValidate ¶
ContextValidate validate this ring statistic item based on the context it is used
func (*RingStatisticItem) MarshalBinary ¶
func (m *RingStatisticItem) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*RingStatisticItem) UnmarshalBinary ¶
func (m *RingStatisticItem) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SearchResult ¶
type SearchResult struct {
// content
Content string `json:"content,omitempty"`
// disabled
Disabled bool `json:"disabled,omitempty"`
// name
Name string `json:"name,omitempty"`
// set to one of "record, zone, comment"
ObjectType string `json:"object_type,omitempty"`
// ttl
TTL int64 `json:"ttl,omitempty"`
// type
Type string `json:"type,omitempty"`
// zone
Zone string `json:"zone,omitempty"`
// zone id
ZoneID string `json:"zone_id,omitempty"`
}
SearchResult SearchResult
swagger:model SearchResult
func (*SearchResult) ContextValidate ¶
ContextValidate validates this search result based on context it is used
func (*SearchResult) MarshalBinary ¶
func (m *SearchResult) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SearchResult) UnmarshalBinary ¶
func (m *SearchResult) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SearchResultComment ¶
type SearchResultComment struct {
// content
Content string `json:"content,omitempty"`
// name
Name string `json:"name,omitempty"`
// set to "comment"
ObjectType string `json:"object_type,omitempty"`
// zone
Zone string `json:"zone,omitempty"`
// zone id
ZoneID string `json:"zone_id,omitempty"`
}
SearchResultComment SearchResultComment
swagger:model SearchResultComment
func (*SearchResultComment) ContextValidate ¶
ContextValidate validates this search result comment based on context it is used
func (*SearchResultComment) MarshalBinary ¶
func (m *SearchResultComment) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SearchResultComment) UnmarshalBinary ¶
func (m *SearchResultComment) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SearchResultRecord ¶
type SearchResultRecord struct {
// content
Content string `json:"content,omitempty"`
// disabled
Disabled bool `json:"disabled,omitempty"`
// name
Name string `json:"name,omitempty"`
// set to "record"
ObjectType string `json:"object_type,omitempty"`
// ttl
TTL int64 `json:"ttl,omitempty"`
// type
Type string `json:"type,omitempty"`
// zone
Zone string `json:"zone,omitempty"`
// zone id
ZoneID string `json:"zone_id,omitempty"`
}
SearchResultRecord SearchResultRecord
swagger:model SearchResultRecord
func (*SearchResultRecord) ContextValidate ¶
ContextValidate validates this search result record based on context it is used
func (*SearchResultRecord) MarshalBinary ¶
func (m *SearchResultRecord) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SearchResultRecord) UnmarshalBinary ¶
func (m *SearchResultRecord) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SearchResultZone ¶
type SearchResultZone struct {
// name
Name string `json:"name,omitempty"`
// set to "zone"
ObjectType string `json:"object_type,omitempty"`
// zone id
ZoneID string `json:"zone_id,omitempty"`
}
SearchResultZone SearchResultZone
swagger:model SearchResultZone
func (*SearchResultZone) ContextValidate ¶
ContextValidate validates this search result zone based on context it is used
func (*SearchResultZone) MarshalBinary ¶
func (m *SearchResultZone) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SearchResultZone) UnmarshalBinary ¶
func (m *SearchResultZone) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type SearchResults ¶
type SearchResults []*SearchResult
SearchResults search results
swagger:model SearchResults
func (SearchResults) ContextValidate ¶
ContextValidate validate this search results based on the context it is used
type Server ¶
type Server struct {
// The API endpoint for this server’s configuration
ConfigURL string `json:"config_url,omitempty"`
// “recursor” for the PowerDNS Recursor and “authoritative” for the Authoritative Server
DaemonType string `json:"daemon_type,omitempty"`
// The id of the server, “localhost”
ID string `json:"id,omitempty"`
// Set to “Server”
Type string `json:"type,omitempty"`
// The API endpoint for this server
URL string `json:"url,omitempty"`
// The version of the server software
Version string `json:"version,omitempty"`
// The API endpoint for this server’s zones
ZonesURL string `json:"zones_url,omitempty"`
}
Server Server
swagger:model Server
func (*Server) ContextValidate ¶
ContextValidate validates this server based on context it is used
func (*Server) MarshalBinary ¶
MarshalBinary interface implementation
func (*Server) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Servers ¶
type Servers []*Server
Servers servers
swagger:model Servers
func (Servers) ContextValidate ¶
ContextValidate validate this servers based on the context it is used
type SimpleStatisticItem ¶
type SimpleStatisticItem struct {
// Item name
Name string `json:"name,omitempty"`
// Item value
Value string `json:"value,omitempty"`
}
SimpleStatisticItem SimpleStatisticItem
swagger:model SimpleStatisticItem
func (*SimpleStatisticItem) ContextValidate ¶
ContextValidate validates this simple statistic item based on context it is used
func (*SimpleStatisticItem) MarshalBinary ¶
func (m *SimpleStatisticItem) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*SimpleStatisticItem) UnmarshalBinary ¶
func (m *SimpleStatisticItem) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type StatisticItem ¶
type StatisticItem struct {
// Item name
Name string `json:"name,omitempty"`
// set to "StatisticItem"
Type string `json:"type,omitempty"`
// Item value
Value string `json:"value,omitempty"`
}
StatisticItem StatisticItem
swagger:model StatisticItem
func (*StatisticItem) ContextValidate ¶
ContextValidate validates this statistic item based on context it is used
func (*StatisticItem) MarshalBinary ¶
func (m *StatisticItem) MarshalBinary() ([]byte, error)
MarshalBinary interface implementation
func (*StatisticItem) UnmarshalBinary ¶
func (m *StatisticItem) UnmarshalBinary(b []byte) error
UnmarshalBinary interface implementation
type TSIGKey ¶
type TSIGKey struct {
// The algorithm of the TSIG key
Algorithm string `json:"algorithm,omitempty"`
// The ID for this key, used in the TSIGkey URL endpoint.
// Read Only: true
ID string `json:"id,omitempty"`
// The Base64 encoded secret key, empty when listing keys. MAY be empty when POSTing to have the server generate the key material
Key string `json:"key,omitempty"`
// The name of the key
Name string `json:"name,omitempty"`
// Set to "TSIGKey"
// Read Only: true
Type string `json:"type,omitempty"`
}
TSIGKey TSIGKey
A TSIG key that can be used to authenticate NOTIFY, AXFR, and DNSUPDATE queries.
swagger:model TSIGKey
func (*TSIGKey) ContextValidate ¶
ContextValidate validate this t s i g key based on the context it is used
func (*TSIGKey) MarshalBinary ¶
MarshalBinary interface implementation
func (*TSIGKey) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Zone ¶
type Zone struct {
// MAY be set. Its value is defined by local policy
Account string `json:"account,omitempty"`
// Whether or not the zone will be rectified on data changes via the API
APIRectify bool `json:"api_rectify,omitempty"`
// Whether or not this zone is DNSSEC signed (inferred from presigned being true XOR presence of at least one cryptokey with active being true)
Dnssec bool `json:"dnssec,omitempty"`
// The SOA serial as seen in query responses. Calculated using the SOA-EDIT metadata, default-soa-edit and default-soa-edit-signed settings
EditedSerial int64 `json:"edited_serial,omitempty"`
// Opaque zone id (string), assigned by the server, should not be interpreted by the application. Guaranteed to be safe for embedding in URLs.
ID string `json:"id,omitempty"`
// Zone kind, one of “Native”, “Master”, “Slave”
// Enum: [Native Master Slave]
Kind string `json:"kind,omitempty"`
// The id of the TSIG keys used for master operation in this zone
MasterTsigKeyIds []string `json:"master_tsig_key_ids"`
// List of IP addresses configured as a master for this zone (“Slave” type zones only)
Masters []string `json:"masters"`
// Name of the zone (e.g. “example.com.”) MUST have a trailing dot
Name string `json:"name,omitempty"`
// MAY be sent in client bodies during creation, and MUST NOT be sent by the server. Simple list of strings of nameserver names, including the trailing dot. Not required for slave zones.
Nameservers []string `json:"nameservers"`
// The SOA serial notifications have been sent out for
NotifiedSerial int64 `json:"notified_serial,omitempty"`
// Whether or not the zone uses NSEC3 narrow
Nsec3narrow bool `json:"nsec3narrow,omitempty"`
// The NSEC3PARAM record
Nsec3param string `json:"nsec3param,omitempty"`
// Whether or not the zone is pre-signed
Presigned bool `json:"presigned,omitempty"`
// RRSets in this zone (for zones/{zone_id} endpoint only; omitted during GET on the .../zones list endpoint)
Rrsets []*RRSet `json:"rrsets"`
// The SOA serial number
Serial int64 `json:"serial,omitempty"`
// The id of the TSIG keys used for slave operation in this zone
SlaveTsigKeyIds []string `json:"slave_tsig_key_ids"`
// The SOA-EDIT metadata item
SoaEdit string `json:"soa_edit,omitempty"`
// The SOA-EDIT-API metadata item
SoaEditAPI string `json:"soa_edit_api,omitempty"`
// Set to “Zone”
Type string `json:"type,omitempty"`
// API endpoint for this zone
URL string `json:"url,omitempty"`
// MAY contain a BIND-style zone file when creating a zone
Zone string `json:"zone,omitempty"`
}
Zone Zone
This represents an authoritative DNS Zone.
swagger:model Zone
func (*Zone) ContextValidate ¶
ContextValidate validate this zone based on the context it is used
func (*Zone) MarshalBinary ¶
MarshalBinary interface implementation
func (*Zone) UnmarshalBinary ¶
UnmarshalBinary interface implementation
type Zones ¶
type Zones []*Zone
Zones zones
swagger:model Zones
func (Zones) ContextValidate ¶
ContextValidate validate this zones based on the context it is used
Source Files
¶
- autoprimary.go
- cache_flush_result.go
- comment.go
- config_setting.go
- cryptokey.go
- error.go
- map_statistic_item.go
- metadata.go
- r_r_set.go
- record.go
- ring_statistic_item.go
- search_result.go
- search_result_comment.go
- search_result_record.go
- search_result_zone.go
- search_results.go
- server.go
- servers.go
- simple_statistic_item.go
- statistic_item.go
- t_s_i_g_key.go
- zone.go
- zones.go