pdnsapi

package module
v0.0.0-...-d95f05e Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 21, 2019 License: Apache-2.0 Imports: 20 Imported by: 27

README

Go API client for pdnsapi

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

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

  • API version: 0.0.13
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.languages.GoClientCodegen

Installation

Put the package under your project folder and add the following in import:

    "./pdnsapi"

Documentation for API Endpoints

All URIs are relative to http://localhost:8081/api/v1

Class Method HTTP request Description
ConfigApi GetConfig Get /servers/{server_id}/config Returns all ConfigSettings for a single server
ConfigApi GetConfigSetting Get /servers/{server_id}/config/{config_setting_name} Returns a specific ConfigSetting for a single server
SearchApi SearchData Get /servers/{server_id}/search-data Search the data inside PowerDNS
SearchApi SearchLog Get /servers/{server_id}/search-log Query the log, filtered by search_term.
ServersApi ListServer Get /servers/{server_id} List a server
ServersApi ListServers Get /servers List all servers
StatsApi GetStats Get /servers/{server_id}/statistics Query statistics.
ZonecryptokeyApi CreateCryptokey Post /servers/{server_id}/zones/{zone_id}/cryptokeys Creates a Cryptokey
ZonecryptokeyApi DeleteCryptokey Delete /servers/{server_id}/zones/{zone_id}/cryptokeys/{cryptokey_id} This method deletes a key specified by cryptokey_id.
ZonecryptokeyApi GetCryptokey Get /servers/{server_id}/zones/{zone_id}/cryptokeys/{cryptokey_id} Returns all data about the CryptoKey, including the privatekey.
ZonecryptokeyApi ListCryptokeys Get /servers/{server_id}/zones/{zone_id}/cryptokeys Get all CryptoKeys for a zone, except the privatekey
ZonecryptokeyApi ModifyCryptokey Put /servers/{server_id}/zones/{zone_id}/cryptokeys/{cryptokey_id} This method (de)activates a key from zone_name specified by cryptokey_id
ZonemetadataApi CreateMetadata Post /servers/{server_id}/zones/{zone_id}/metadata Creates a set of metadata entries
ZonemetadataApi DeleteMetadata Delete /servers/{server_id}/zones/{zone_id}/metadata/{metadata_kind} Delete all items of a single kind of domain metadata.
ZonemetadataApi GetMetadata Get /servers/{server_id}/zones/{zone_id}/metadata/{metadata_kind} Get the content of a single kind of domain metadata as a list of MetaData objects.
ZonemetadataApi ListMetadata Get /servers/{server_id}/zones/{zone_id}/metadata Get all the MetaData associated with the zone.
ZonemetadataApi ModifyMetadata Put /servers/{server_id}/zones/{zone_id}/metadata/{metadata_kind} Modify the content of a single kind of domain metadata.
ZonesApi AxfrExportZone Get /servers/{server_id}/zones/{zone_id}/export Returns the zone in AXFR format.
ZonesApi AxfrRetrieveZone Put /servers/{server_id}/zones/{zone_id}/axfr-retrieve Send a DNS NOTIFY to all slaves.
ZonesApi CheckZone Get /servers/{server_id}/zones/{zone_id}/check Verify zone contents/configuration.
ZonesApi CreateZone Post /servers/{server_id}/zones Creates a new domain, returns the Zone on creation.
ZonesApi DeleteZone Delete /servers/{server_id}/zones/{zone_id} Deletes this zone, all attached metadata and rrsets.
ZonesApi ListZone Get /servers/{server_id}/zones/{zone_id} zone managed by a server
ZonesApi ListZones Get /servers/{server_id}/zones List all Zones in a server
ZonesApi NotifyZone Put /servers/{server_id}/zones/{zone_id}/notify Send a DNS NOTIFY to all slaves.
ZonesApi PatchZone Patch /servers/{server_id}/zones/{zone_id} Creates/modifies/deletes RRsets present in the payload and their comments. Returns 204 No Content on success.
ZonesApi PutZone Put /servers/{server_id}/zones/{zone_id} Modifies basic zone data (metadata).
ZonesApi RectifyZone Put /servers/{server_id}/zones/{zone_id}/rectify Rectify the zone data.

Documentation For Models

Documentation For Authorization

APIKeyHeader

  • Type: API key

Example

	auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
		Key: "APIKEY",
		Prefix: "Bearer", // Omit if not necessary.
	})
    r, err := client.Service.Operation(auth, args)

Author

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires 

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient 

type APIClient struct {

	// API Services
	ConfigApi        *ConfigApiService
	SearchApi        *SearchApiService
	ServersApi       *ServersApiService
	StatsApi         *StatsApiService
	ZonecryptokeyApi *ZonecryptokeyApiService
	ZonemetadataApi  *ZonemetadataApiService
	ZonesApi         *ZonesApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the PowerDNS Authoritative HTTP API API v0.0.13 In most cases there should be only one, shared, APIClient.

func NewAPIClient 

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath 

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey 

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse 

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse 

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError 

func NewAPIResponseWithError(errorMessage string) *APIResponse

type BaseStatisticItem 

type BaseStatisticItem struct {

	// The name of this item (e.g. ‘uptime’)
	Name string `json:"name,omitempty"`
}

type BasicAuth 

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

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 ConfigApiService 

type ConfigApiService service

func (*ConfigApiService) GetConfig 

func (a *ConfigApiService) GetConfig(ctx context.Context, serverId string) ([]ConfigSetting, *http.Response, error)

ConfigApiService Returns all ConfigSettings for a single server * @param ctx context.Context for authentication, logging, tracing, etc. @param serverId The id of the server to retrieve @return []ConfigSetting

func (*ConfigApiService) GetConfigSetting 

func (a *ConfigApiService) GetConfigSetting(ctx context.Context, serverId string, configSettingName string) (ConfigSetting, *http.Response, error)

ConfigApiService Returns a specific ConfigSetting for a single server NOT IMPLEMENTED * @param ctx context.Context for authentication, logging, tracing, etc. @param serverId The id of the server to retrieve @param configSettingName The name of the setting to retrieve @return ConfigSetting

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 Configuration 

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration 

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader 

func (c *Configuration) AddDefaultHeader(key string, value string)

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 MapStatisticItemValue 

type MapStatisticItemValue struct {

	// item name
	Name string `json:"name,omitempty"`

	// item value
	Value string `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 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 SearchApiService 

type SearchApiService service

func (*SearchApiService) SearchData 

func (a *SearchApiService) SearchData(ctx context.Context, serverId string, q string, max int32) (SearchResults, *http.Response, error)

SearchApiService Search the data inside PowerDNS Search the data inside PowerDNS for search_term and return at most max_results. This includes zones, records and comments. The * character can be used in search_term as a wildcard character and the ? character can be used as a wildcard for a single character. * @param ctx context.Context for authentication, logging, tracing, etc. @param serverId The id of the server to retrieve @param q The string to search for @param max Maximum number of entries to return @return SearchResults

func (*SearchApiService) SearchLog 

func (a *SearchApiService) SearchLog(ctx context.Context, serverId string, q string) ([]string, *http.Response, error)

SearchApiService Query the log, filtered by search_term. * @param ctx context.Context for authentication, logging, tracing, etc. @param serverId The id of the server to retrieve @param q The string to search for @return []string

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 ServersApiService 

type ServersApiService service

func (*ServersApiService) ListServer 

func (a *ServersApiService) ListServer(ctx context.Context, serverId string) (Server, *http.Response, error)

ServersApiService List a server * @param ctx context.Context for authentication, logging, tracing, etc. @param serverId The id of the server to retrieve @return Server

func (*ServersApiService) ListServers 

func (a *ServersApiService) ListServers(ctx context.Context) ([]Server, *http.Response, error)

ServersApiService List all servers * @param ctx context.Context for authentication, logging, tracing, etc. @return []Server

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 StatsApiService 

type StatsApiService service

func (*StatsApiService) GetStats 

func (a *StatsApiService) GetStats(ctx context.Context, serverId string) ([]StatisticItem, *http.Response, error)

StatsApiService Query statistics. Query PowerDNS internal statistics. Returns a list of StatisticItem elements. * @param ctx context.Context for authentication, logging, tracing, etc. @param serverId The id of the server to retrieve @return []StatisticItem

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

	// 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 ZonecryptokeyApiService 

type ZonecryptokeyApiService service

func (*ZonecryptokeyApiService) CreateCryptokey 

func (a *ZonecryptokeyApiService) CreateCryptokey(ctx context.Context, serverId string, zoneId string, cryptokey Cryptokey) (Cryptokey, *http.Response, error)

ZonecryptokeyApiService Creates a Cryptokey This method adds a new key to a zone. The key can either be generated or imported by supplying the content parameter. if content, bits and algo are null, a key will be generated based on the default-ksk-algorithm and default-ksk-size settings for a KSK and the default-zsk-algorithm and default-zsk-size options for a ZSK. * @param ctx context.Context for authentication, logging, tracing, etc. @param serverId The id of the server to retrieve @param zoneId @param cryptokey Add a Cryptokey @return Cryptokey

func (*ZonecryptokeyApiService) DeleteCryptokey 

func (a *ZonecryptokeyApiService) DeleteCryptokey(ctx context.Context, serverId string, zoneId string, cryptokeyId string) (*http.Response, error)

ZonecryptokeyApiService This method deletes a key specified by cryptokey_id. * @param ctx context.Context for authentication, logging, tracing, etc. @param serverId The id of the server to retrieve @param zoneId The id of the zone to retrieve @param cryptokeyId The id value of the Cryptokey @return

func (*ZonecryptokeyApiService) GetCryptokey 

func (a *ZonecryptokeyApiService) GetCryptokey(ctx context.Context, serverId string, zoneId string, cryptokeyId string) (Cryptokey, *http.Response, error)

ZonecryptokeyApiService Returns all data about the CryptoKey, including the privatekey. * @param ctx context.Context for authentication, logging, tracing, etc. @param serverId The id of the server to retrieve @param zoneId The id of the zone to retrieve @param cryptokeyId The id value of the CryptoKey @return Cryptokey

func (*ZonecryptokeyApiService) ListCryptokeys 

func (a *ZonecryptokeyApiService) ListCryptokeys(ctx context.Context, serverId string, zoneId string) ([]Cryptokey, *http.Response, error)

ZonecryptokeyApiService Get all CryptoKeys for a zone, except the privatekey * @param ctx context.Context for authentication, logging, tracing, etc. @param serverId The id of the server to retrieve @param zoneId The id of the zone to retrieve @return []Cryptokey

func (*ZonecryptokeyApiService) ModifyCryptokey 

func (a *ZonecryptokeyApiService) ModifyCryptokey(ctx context.Context, serverId string, zoneId string, cryptokeyId string, cryptokey Cryptokey) (*http.Response, error)

ZonecryptokeyApiService This method (de)activates a key from zone_name specified by cryptokey_id * @param ctx context.Context for authentication, logging, tracing, etc. @param serverId The id of the server to retrieve @param zoneId @param cryptokeyId Cryptokey to manipulate @param cryptokey the Cryptokey @return

type ZonemetadataApiService 

type ZonemetadataApiService service

func (*ZonemetadataApiService) CreateMetadata 

func (a *ZonemetadataApiService) CreateMetadata(ctx context.Context, serverId string, zoneId string, metadata []Metadata) (*http.Response, error)

ZonemetadataApiService Creates a set of metadata entries Creates a set of metadata entries of given kind for the zone. Existing metadata entries for the zone with the same kind are not overwritten. * @param ctx context.Context for authentication, logging, tracing, etc. @param serverId The id of the server to retrieve @param zoneId @param metadata List of metadata to add/create @return

func (*ZonemetadataApiService) DeleteMetadata 

func (a *ZonemetadataApiService) DeleteMetadata(ctx context.Context, serverId string, zoneId string, metadataKind string) (*http.Response, error)

ZonemetadataApiService Delete all items of a single kind of domain metadata. * @param ctx context.Context for authentication, logging, tracing, etc. @param serverId The id of the server to retrieve @param zoneId The id of the zone to retrieve @param metadataKind ??? @return

func (*ZonemetadataApiService) GetMetadata 

func (a *ZonemetadataApiService) GetMetadata(ctx context.Context, serverId string, zoneId string, metadataKind string) (Metadata, *http.Response, error)

ZonemetadataApiService Get the content of a single kind of domain metadata as a list of MetaData objects. * @param ctx context.Context for authentication, logging, tracing, etc. @param serverId The id of the server to retrieve @param zoneId The id of the zone to retrieve @param metadataKind ??? @return Metadata

func (*ZonemetadataApiService) ListMetadata 

func (a *ZonemetadataApiService) ListMetadata(ctx context.Context, serverId string, zoneId string) ([]Metadata, *http.Response, error)

ZonemetadataApiService Get all the MetaData associated with the zone. * @param ctx context.Context for authentication, logging, tracing, etc. @param serverId The id of the server to retrieve @param zoneId The id of the zone to retrieve @return []Metadata

func (*ZonemetadataApiService) ModifyMetadata 

func (a *ZonemetadataApiService) ModifyMetadata(ctx context.Context, serverId string, zoneId string, metadataKind string, metadata Metadata) (*http.Response, error)

ZonemetadataApiService Modify the content of a single kind of domain metadata. * @param ctx context.Context for authentication, logging, tracing, etc. @param serverId The id of the server to retrieve @param zoneId @param metadataKind The kind of metadata @param metadata metadata to add/create @return

type Zones 

type Zones struct {
}

type ZonesApiService 

type ZonesApiService service

func (*ZonesApiService) AxfrExportZone 

func (a *ZonesApiService) AxfrExportZone(ctx context.Context, serverId string, zoneId string) (string, *http.Response, error)

ZonesApiService Returns the zone in AXFR format. * @param ctx context.Context for authentication, logging, tracing, etc. @param serverId The id of the server to retrieve @param zoneId The id of the zone to retrieve @return string

func (*ZonesApiService) AxfrRetrieveZone 

func (a *ZonesApiService) AxfrRetrieveZone(ctx context.Context, serverId string, zoneId string) (*http.Response, error)

ZonesApiService Send a DNS NOTIFY to all slaves. Fails when zone kind is not Master or Slave, or master and slave are disabled in the configuration. Only works for Slave if renotify is on. Clients MUST NOT send a body. * @param ctx context.Context for authentication, logging, tracing, etc. @param serverId The id of the server to retrieve @param zoneId The id of the zone to retrieve @return

func (*ZonesApiService) CheckZone 

func (a *ZonesApiService) CheckZone(ctx context.Context, serverId string, zoneId string) (string, *http.Response, error)

ZonesApiService Verify zone contents/configuration. * @param ctx context.Context for authentication, logging, tracing, etc. @param serverId The id of the server to retrieve @param zoneId The id of the zone to retrieve @return string

func (*ZonesApiService) CreateZone 

func (a *ZonesApiService) CreateZone(ctx context.Context, serverId string, localVarOptionals map[string]interface{}) (Zone, *http.Response, error)

ZonesApiService Creates a new domain, returns the Zone on creation. * @param ctx context.Context for authentication, logging, tracing, etc. @param serverId The id of the server to retrieve @param optional (nil or map[string]interface{}) with one or more of: 

@param "rrsets" (bool) “true” (default) or “false”, whether to include the “rrsets” in the response Zone object.

@return Zone

func (*ZonesApiService) DeleteZone 

func (a *ZonesApiService) DeleteZone(ctx context.Context, serverId string, zoneId string) (*http.Response, error)

ZonesApiService Deletes this zone, all attached metadata and rrsets. * @param ctx context.Context for authentication, logging, tracing, etc. @param serverId The id of the server to retrieve @param zoneId The id of the zone to retrieve @return

func (*ZonesApiService) ListZone 

func (a *ZonesApiService) ListZone(ctx context.Context, serverId string, zoneId string) (Zone, *http.Response, error)

ZonesApiService zone managed by a server * @param ctx context.Context for authentication, logging, tracing, etc. @param serverId The id of the server to retrieve @param zoneId The id of the zone to retrieve @return Zone

func (*ZonesApiService) ListZones 

func (a *ZonesApiService) ListZones(ctx context.Context, serverId string) ([]Zone, *http.Response, error)

ZonesApiService List all Zones in a server * @param ctx context.Context for authentication, logging, tracing, etc. @param serverId The id of the server to retrieve @return []Zone

func (*ZonesApiService) NotifyZone 

func (a *ZonesApiService) NotifyZone(ctx context.Context, serverId string, zoneId string) (*http.Response, error)

ZonesApiService Send a DNS NOTIFY to all slaves. Fails when zone kind is not Master or Slave, or master and slave are disabled in the configuration. Only works for Slave if renotify is on. Clients MUST NOT send a body. * @param ctx context.Context for authentication, logging, tracing, etc. @param serverId The id of the server to retrieve @param zoneId The id of the zone to retrieve @return

func (*ZonesApiService) PatchZone 

func (a *ZonesApiService) PatchZone(ctx context.Context, serverId string, zoneId string, zoneStruct Zone) (*http.Response, error)

ZonesApiService Creates/modifies/deletes RRsets present in the payload and their comments. Returns 204 No Content on success. * @param ctx context.Context for authentication, logging, tracing, etc. @param serverId The id of the server to retrieve @param zoneId @param zoneStruct The zone struct to patch with @return

func (*ZonesApiService) PutZone 

func (a *ZonesApiService) PutZone(ctx context.Context, serverId string, zoneId string, zoneStruct Zone) (*http.Response, error)

ZonesApiService Modifies basic zone data (metadata). Allowed fields in client body: all except id, url and name. Returns 204 No Content on success. * @param ctx context.Context for authentication, logging, tracing, etc. @param serverId The id of the server to retrieve @param zoneId @param zoneStruct The zone struct to patch with @return

func (*ZonesApiService) RectifyZone 

func (a *ZonesApiService) RectifyZone(ctx context.Context, serverId string, zoneId string) (string, *http.Response, error)

ZonesApiService Rectify the zone data. This does not take into account the API-RECTIFY metadata. Fails on slave zones and zones that do not have DNSSEC. * @param ctx context.Context for authentication, logging, tracing, etc. @param serverId The id of the server to retrieve @param zoneId The id of the zone to retrieve @return string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.