Categorygithub.com/ffledgling/pdns-go
repositorypackage
0.0.0-20191021083206-d95f05e1f9cf
Repository: https://github.com/ffledgling/pdns-go.git
Documentation: pkg.go.dev

# 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

ClassMethodHTTP requestDescription
ConfigApiGetConfigGet /servers/{server_id}/configReturns all ConfigSettings for a single server
ConfigApiGetConfigSettingGet /servers/{server_id}/config/{config_setting_name}Returns a specific ConfigSetting for a single server
SearchApiSearchDataGet /servers/{server_id}/search-dataSearch the data inside PowerDNS
SearchApiSearchLogGet /servers/{server_id}/search-logQuery the log, filtered by search_term.
ServersApiListServerGet /servers/{server_id}List a server
ServersApiListServersGet /serversList all servers
StatsApiGetStatsGet /servers/{server_id}/statisticsQuery statistics.
ZonecryptokeyApiCreateCryptokeyPost /servers/{server_id}/zones/{zone_id}/cryptokeysCreates a Cryptokey
ZonecryptokeyApiDeleteCryptokeyDelete /servers/{server_id}/zones/{zone_id}/cryptokeys/{cryptokey_id}This method deletes a key specified by cryptokey_id.
ZonecryptokeyApiGetCryptokeyGet /servers/{server_id}/zones/{zone_id}/cryptokeys/{cryptokey_id}Returns all data about the CryptoKey, including the privatekey.
ZonecryptokeyApiListCryptokeysGet /servers/{server_id}/zones/{zone_id}/cryptokeysGet all CryptoKeys for a zone, except the privatekey
ZonecryptokeyApiModifyCryptokeyPut /servers/{server_id}/zones/{zone_id}/cryptokeys/{cryptokey_id}This method (de)activates a key from zone_name specified by cryptokey_id
ZonemetadataApiCreateMetadataPost /servers/{server_id}/zones/{zone_id}/metadataCreates a set of metadata entries
ZonemetadataApiDeleteMetadataDelete /servers/{server_id}/zones/{zone_id}/metadata/{metadata_kind}Delete all items of a single kind of domain metadata.
ZonemetadataApiGetMetadataGet /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.
ZonemetadataApiListMetadataGet /servers/{server_id}/zones/{zone_id}/metadataGet all the MetaData associated with the zone.
ZonemetadataApiModifyMetadataPut /servers/{server_id}/zones/{zone_id}/metadata/{metadata_kind}Modify the content of a single kind of domain metadata.
ZonesApiAxfrExportZoneGet /servers/{server_id}/zones/{zone_id}/exportReturns the zone in AXFR format.
ZonesApiAxfrRetrieveZonePut /servers/{server_id}/zones/{zone_id}/axfr-retrieveSend a DNS NOTIFY to all slaves.
ZonesApiCheckZoneGet /servers/{server_id}/zones/{zone_id}/checkVerify zone contents/configuration.
ZonesApiCreateZonePost /servers/{server_id}/zonesCreates a new domain, returns the Zone on creation.
ZonesApiDeleteZoneDelete /servers/{server_id}/zones/{zone_id}Deletes this zone, all attached metadata and rrsets.
ZonesApiListZoneGet /servers/{server_id}/zones/{zone_id}zone managed by a server
ZonesApiListZonesGet /servers/{server_id}/zonesList all Zones in a server
ZonesApiNotifyZonePut /servers/{server_id}/zones/{zone_id}/notifySend a DNS NOTIFY to all slaves.
ZonesApiPatchZonePatch /servers/{server_id}/zones/{zone_id}Creates/modifies/deletes RRsets present in the payload and their comments. Returns 204 No Content on success.
ZonesApiPutZonePut /servers/{server_id}/zones/{zone_id}Modifies basic zone data (metadata).
ZonesApiRectifyZonePut /servers/{server_id}/zones/{zone_id}/rectifyRectify 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