README

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

Installation & Usage

Requirements

PHP 8.1 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure API key authorization: APIKeyHeader
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKey('X-API-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-API-Key', 'Bearer');


$apiInstance = new OpenAPI\Client\Api\AutoprimaryApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$server_id = 'server_id_example'; // string | The id of the server to retrieve
$autoprimary = new \OpenAPI\Client\Model\Autoprimary(); // \OpenAPI\Client\Model\Autoprimary | autoprimary entry to add

try {
    $apiInstance->createAutoprimary($server_id, $autoprimary);
} catch (Exception $e) {
    echo 'Exception when calling AutoprimaryApi->createAutoprimary: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to /api/v1

Class	Method	HTTP request	Description
AutoprimaryApi	createAutoprimary	POST /servers/{server_id}/autoprimaries	Add an autoprimary
AutoprimaryApi	deleteAutoprimary	DELETE /servers/{server_id}/autoprimaries/{ip}/{nameserver}	Delete the autoprimary entry
AutoprimaryApi	getAutoprimaries	GET /servers/{server_id}/autoprimaries	Get a list of autoprimaries
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
DefaultApi	error	GET /error	Will always generate an error
NetworksApi	getNetwork	GET /servers/{server_id}/networks/{ip}/{prefixlen}	Return the view associated to the given network
NetworksApi	listNetworks	GET /servers/{server_id}/networks	List all registered networks and views in a server
NetworksApi	setNetwork	PUT /servers/{server_id}/networks/{ip}/{prefixlen}	Sets the view associated to the given network
SearchApi	searchData	GET /servers/{server_id}/search-data	Search the data inside PowerDNS
ServersApi	cacheFlushByName	PUT /servers/{server_id}/cache/flush	Flush a cache-entry by name
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.
TsigkeyApi	createTSIGKey	POST /servers/{server_id}/tsigkeys	Add a TSIG key
TsigkeyApi	deleteTSIGKey	DELETE /servers/{server_id}/tsigkeys/{tsigkey_id}	Delete the TSIGKey with tsigkey_id
TsigkeyApi	getTSIGKey	GET /servers/{server_id}/tsigkeys/{tsigkey_id}	Get a specific TSIGKeys on the server, including the actual key
TsigkeyApi	listTSIGKeys	GET /servers/{server_id}/tsigkeys	Get all TSIGKeys on the server, except the actual key
TsigkeyApi	putTSIGKey	PUT /servers/{server_id}/tsigkeys/{tsigkey_id}
ViewsApi	addToView	POST /servers/{server_id}/views/{view}	Adds a zone to a given view, creating it if needed
ViewsApi	deleteFromView	DELETE /servers/{server_id}/views/{view}/{id}	Removes the given zone from the given view
ViewsApi	listView	GET /servers/{server_id}/views/{view}	List the contents of a given view
ViewsApi	listViews	GET /servers/{server_id}/views	List all views in a server
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 Metadata object.
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}	Replace 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	Retrieve slave zone from its master.
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.
ZonesApi	rectifyZone	PUT /servers/{server_id}/zones/{zone_id}/rectify	Rectify the zone data.

Models

Authorization

Authentication schemes defined for the API:

APIKeyHeader

Type: API key
API key parameter name: X-API-Key
Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 0.0.20
- Generator version: 7.25.0-SNAPSHOT
Build package: org.openapitools.codegen.languages.PhpClientCodegen

suguer / powerdns

Maintainers

Package info

Statistics

Security