ottoyiu / pdns-go

Swagger based go-client for pdns

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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

Generate from Source using Docker

  1. Download swagger spec from PowerDNS in to working directory: https://raw.githubusercontent.com/PowerDNS/pdns/master/docs/http-api/swagger/authoritative-api-swagger.yaml

  2. Run: docker run --rm -v ${PWD}:/local swaggerapi/swagger-codegen-cli generate -i /local/authoritative-api-swagger.yaml -l go -o /local/out/go -DpackageName=pdnsapi

The output should be in out/go.

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

About

Swagger based go-client for pdns

License:Apache License 2.0


Languages

Language:Go 98.5%Language:Shell 1.5%