modelpowerdns

Documentation

Overview

• PowerDNS Authoritative HTTP API *

• No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) *

• API version: 0.0.13

• Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

• PowerDNS Authoritative HTTP API *

• No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) *

• API version: 0.0.13

• Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

• PowerDNS Authoritative HTTP API *

• No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) *

• API version: 0.0.13

• Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

• PowerDNS Authoritative HTTP API *

• No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) *

• API version: 0.0.13

• Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

PowerDNS Authoritative HTTP API

*
* No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
*
* API version: 0.0.13
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* PowerDNS Authoritative HTTP API
*
* No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
*
* API version: 0.0.13
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

PowerDNS Authoritative HTTP API

*
* No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
*
* API version: 0.0.13
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* PowerDNS Authoritative HTTP API
*
* No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
*
* API version: 0.0.13
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* PowerDNS Authoritative HTTP API
*
* No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
*
* API version: 0.0.13
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* PowerDNS Authoritative HTTP API
*
* No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
*
* API version: 0.0.13
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* PowerDNS Authoritative HTTP API
*
* No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
*
* API version: 0.0.13
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

PowerDNS Authoritative HTTP API

*
* No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
*
* API version: 0.0.13
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

PowerDNS Authoritative HTTP API

*
* No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
*
* API version: 0.0.13
* Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index

• type CacheFlushResult
• type Comment
• type ConfigSetting
• type Cryptokey
• type MapStatisticItem
• type Metadata
• type ModelError
• type PDNSconnectionobject
• type Record
• type RingStatisticItem
• type RrSet
• type SearchResult
• type SearchResultComment
• type SearchResultRecord
• type SearchResultZone
• type SearchResults
• type Server
• type Servers
• type SimpleStatisticItem
• type StatisticItem
• type TsigKey
• type Zone
• type Zones

Types

type CacheFlushResult

type CacheFlushResult struct {
	// Amount of entries flushed
	Count float32 `json:"count,omitempty"`
	// A message about the result like \"Flushed cache\"
	Result string `json:"result,omitempty"`
}

The result of a cache-flush.

type Comment

type Comment struct {
	// The actual comment
	Content string `json:"content,omitempty"`
	// Name of an account that added the comment
	Account string `json:"account,omitempty"`
	// Timestamp of the last change to the comment
	ModifiedAt int32 `json:"modified_at,omitempty"`
}

A comment about an RRSet.

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"`
}

type Cryptokey

type Cryptokey struct {
	// set to \"Cryptokey\"
	Type_ string `json:"type,omitempty"`
	// The internal identifier, read only
	ID      int32  `json:"id,omitempty"`
	Keytype string `json:"keytype,omitempty"`
	// Whether or not the key is in active use
	Active bool `json:"active,omitempty"`
	// The DNSKEY record for this key
	Dnskey string `json:"dnskey,omitempty"`
	// An array of DS records for this key
	Ds []string `json:"ds,omitempty"`
	// The private key in ISC format
	Privatekey string `json:"privatekey,omitempty"`
	// The name of the algorithm of the key, should be a mnemonic
	Algorithm string `json:"algorithm,omitempty"`
	// The size of the key
	Bits int32 `json:"bits,omitempty"`
}

Describes a DNSSEC cryptographic key.

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,omitempty"`
}

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,omitempty"`
}

Represents zone metadata.

type ModelError

type ModelError struct {
	// A human readable error message
	Error_ string `json:"error"`
	// Optional array of multiple errors encountered during processing
	Errors []string `json:"errors,omitempty"`
}

Returned when the server encounters an error. Either in client input or internally.

type PDNSconnectionobject

type PDNSconnectionobject struct {
	PowerDNSurl string
	ServerID    string
	Apitoken    string
}

type Record

type Record struct {
	// The content of this record
	Content string `json:"content"`
	// Whether or not this record is disabled. When unset, the record is not disabled
	Disabled bool `json:"disabled,omitempty"`
	// If set to true, the server will find the matching reverse zone and create a PTR there. Existing PTR records are replaced. If no matching reverse Zone, an error is thrown. Only valid in client bodies, only valid for A and AAAA types. Not returned by the server. This feature is deprecated and will be removed in 4.3.0.
	SetPtr bool `json:"set-ptr,omitempty"`
}

The RREntry object represents a single record.

type RingStatisticItem

type RingStatisticItem struct {
	// Item name
	Name string `json:"name,omitempty"`
	// Set to \"RingStatisticItem\"
	Type_ string `json:"type,omitempty"`
	// Ring size
	Size int32 `json:"size,omitempty"`
	// Named values
	Value []SimpleStatisticItem `json:"value,omitempty"`
}

type RrSet

type RrSet struct {
	// Name for record set (e.g. “www.powerdns.com.”)
	Name string `json:"name"`
	// Type of this record (e.g. “A”, “PTR”, “MX”)
	Type_ string `json:"type"`
	// DNS TTL of the records, in seconds. MUST NOT be included when changetype is set to “DELETE”.
	TTL int32 `json:"ttl"`
	// 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.
	Changetype string `json:"changetype"`
	// 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).
	Records []Record `json:"records"`
	// 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,omitempty"`
}

This represents a Resource Record Set (all records with the same name and type).

type SearchResult

type SearchResult struct {
	Content  string `json:"content,omitempty"`
	Disabled bool   `json:"disabled,omitempty"`
	Name     string `json:"name,omitempty"`
	// set to one of \"record, zone, comment\"
	ObjectType string `json:"object_type,omitempty"`
	ZoneID     string `json:"zone_id,omitempty"`
	Zone       string `json:"zone,omitempty"`
	Type_      string `json:"type,omitempty"`
	TTL        int32  `json:"ttl,omitempty"`
}

type SearchResultComment

type SearchResultComment struct {
	Content string `json:"content,omitempty"`
	Name    string `json:"name,omitempty"`
	// set to \"comment\"
	ObjectType string `json:"object_type,omitempty"`
	ZoneID     string `json:"zone_id,omitempty"`
	Zone       string `json:"zone,omitempty"`
}

type SearchResultRecord

type SearchResultRecord struct {
	Content  string `json:"content,omitempty"`
	Disabled bool   `json:"disabled,omitempty"`
	Name     string `json:"name,omitempty"`
	// set to \"record\"
	ObjectType string `json:"object_type,omitempty"`
	ZoneID     string `json:"zone_id,omitempty"`
	Zone       string `json:"zone,omitempty"`
	Type_      string `json:"type,omitempty"`
	TTL        int32  `json:"ttl,omitempty"`
}

type SearchResultZone

type SearchResultZone struct {
	Name string `json:"name,omitempty"`
	// set to \"zone\"
	ObjectType string `json:"object_type,omitempty"`
	ZoneID     string `json:"zone_id,omitempty"`
}

type SearchResults

type SearchResults struct {
}

type Server

type Server struct {
	// Set to “Server”
	Type_ string `json:"type,omitempty"`
	// The id of the server, “localhost”
	ID string `json:"id,omitempty"`
	// “recursor” for the PowerDNS Recursor and “authoritative” for the Authoritative Server
	DaemonType string `json:"daemon_type,omitempty"`
	// The version of the server software
	Version string `json:"version,omitempty"`
	// The API endpoint for this server
	URL string `json:"url,omitempty"`
	// The API endpoint for this server’s configuration
	ConfigURL string `json:"config_url,omitempty"`
	// The API endpoint for this server’s zones
	ZonesURL string `json:"zones_url,omitempty"`
}

type Servers

type Servers struct {
}

type SimpleStatisticItem

type SimpleStatisticItem struct {
	// Item name
	Name string `json:"name,omitempty"`
	// Item value
	Value string `json:"value,omitempty"`
}

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"`
}

type TsigKey

type TsigKey struct {
	// The name of the key
	Name string `json:"name,omitempty"`
	// The ID for this key, used in the TSIGkey URL endpoint.
	ID string `json:"id,omitempty"`
	// The algorithm of the TSIG key
	Algorithm string `json:"algorithm,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"`
	// Set to \"TSIGKey\"
	Type_ string `json:"type,omitempty"`
}

A TSIG key that can be used to authenticate NOTIFYs and AXFRs.

type Zone

type Zone struct {
	// 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"`
	// Name of the zone (e.g. “example.com.”) MUST have a trailing dot
	Name string `json:"name,omitempty"`
	// Set to “Zone”
	Type_ string `json:"type,omitempty"`
	// API endpoint for this zone
	URL string `json:"url,omitempty"`
	// Zone kind, one of “Native”, “Master”, “Slave”
	Kind string `json:"kind,omitempty"`
	// RRSets in this zone
	Rrsets []RrSet `json:"rrsets,omitempty"`
	// The SOA serial number
	Serial int32 `json:"serial,omitempty"`
	// The SOA serial notifications have been sent out for
	NotifiedSerial int64 `json:"notified_serial,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 int32 `json:"edited_serial,omitempty"`
	//  List of IP addresses configured as a master for this zone (“Slave” type zones only)
	Masters []string `json:"masters,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 NSEC3PARAM record
	Nsec3param string `json:"nsec3param,omitempty"`
	// Whether or not the zone uses NSEC3 narrow
	Nsec3narrow bool `json:"nsec3narrow,omitempty"`
	// Whether or not the zone is pre-signed
	Presigned bool `json:"presigned,omitempty"`
	// The SOA-EDIT metadata item
	SoaEdit string `json:"soa_edit,omitempty"`
	// The SOA-EDIT-API metadata item
	SoaEditAPI string `json:"soa_edit_api,omitempty"`
	//  Whether or not the zone will be rectified on data changes via the API
	APIRectify bool `json:"api_rectify,omitempty"`
	// MAY contain a BIND-style zone file when creating a zone
	Zone string `json:"zone,omitempty"`
	// MAY be set. Its value is defined by local policy
	Account string `json:"account,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 id of the TSIG keys used for master operation in this zone
	MasterTsigKeyIds []string `json:"master_tsig_key_ids,omitempty"`
	// The id of the TSIG keys used for slave operation in this zone
	SlaveTsigKeyIds []string `json:"slave_tsig_key_ids,omitempty"`
}

This represents an authoritative DNS Zone.

type Zones

type Zones struct {
}