Skip to content

Latest commit

 

History

History
328 lines (230 loc) · 11 KB

NameserverServiceApi.md

File metadata and controls

328 lines (230 loc) · 11 KB

Savvii\OpenproviderRest\NameserverServiceApi

All URIs are relative to https://api.openprovider.eu, except if the operation defines another base path.

Method HTTP request Description
createNameserver() POST /v1beta/dns/nameservers Create nameserver
deleteNameserver() DELETE /v1beta/dns/nameservers/{name} Delete nameserver
getNameserver() GET /v1beta/dns/nameservers/{name} Get nameserver
listNameservers() GET /v1beta/dns/nameservers List nameservers
updateNameserver() PUT /v1beta/dns/nameservers/{name} Update nameserver

createNameserver()

createNameserver($body): \Savvii\OpenproviderRest\Model\NameserverCreateNameserverResponse

Create nameserver

Example

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


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


$apiInstance = new Savvii\OpenproviderRest\Api\NameserverServiceApi(
    // 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
);
$body = new \Savvii\OpenproviderRest\Model\NameserverNameserver(); // \Savvii\OpenproviderRest\Model\NameserverNameserver

try {
    $result = $apiInstance->createNameserver($body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NameserverServiceApi->createNameserver: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
body \Savvii\OpenproviderRest\Model\NameserverNameserver

Return type

\Savvii\OpenproviderRest\Model\NameserverCreateNameserverResponse

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

deleteNameserver()

deleteNameserver($name): \Savvii\OpenproviderRest\Model\NameserverNameserverBoolResponse

Delete nameserver

Example

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


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


$apiInstance = new Savvii\OpenproviderRest\Api\NameserverServiceApi(
    // 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
);
$name = 'name_example'; // string | Nameserver name

try {
    $result = $apiInstance->deleteNameserver($name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NameserverServiceApi->deleteNameserver: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
name string Nameserver name

Return type

\Savvii\OpenproviderRest\Model\NameserverNameserverBoolResponse

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getNameserver()

getNameserver($name): \Savvii\OpenproviderRest\Model\NameserverGetNameserverResponse

Get nameserver

Example

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


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


$apiInstance = new Savvii\OpenproviderRest\Api\NameserverServiceApi(
    // 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
);
$name = 'name_example'; // string | Nameserver name

try {
    $result = $apiInstance->getNameserver($name);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NameserverServiceApi->getNameserver: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
name string Nameserver name

Return type

\Savvii\OpenproviderRest\Model\NameserverGetNameserverResponse

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

listNameservers()

listNameservers($name, $ip, $ip6, $pattern, $limit, $offset, $order, $order_by): \Savvii\OpenproviderRest\Model\NameserverListNameserversResponse

List nameservers

Example

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


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


$apiInstance = new Savvii\OpenproviderRest\Api\NameserverServiceApi(
    // 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
);
$name = 'name_example'; // string | Nameserver name.
$ip = 'ip_example'; // string | Nameserver IP.
$ip6 = 'ip6_example'; // string | Nameserver IPv6.
$pattern = 'pattern_example'; // string | Nameserver name search pattern. Wildcatd (*) can be used.
$limit = 100; // int | Limits the number of objects in the output.
$offset = 'offset_example'; // string | Used to retrieve all objects from a certain offset up to the limit.
$order = 'asc'; // string | Sorting type (asc/desc).
$order_by = 'name'; // string | Field for sorting output. Possible values: id, name.

try {
    $result = $apiInstance->listNameservers($name, $ip, $ip6, $pattern, $limit, $offset, $order, $order_by);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NameserverServiceApi->listNameservers: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
name string Nameserver name. [optional]
ip string Nameserver IP. [optional]
ip6 string Nameserver IPv6. [optional]
pattern string Nameserver name search pattern. Wildcatd (*) can be used. [optional]
limit int Limits the number of objects in the output. [optional] [default to 100]
offset string Used to retrieve all objects from a certain offset up to the limit. [optional]
order string Sorting type (asc/desc). [optional] [default to 'asc']
order_by string Field for sorting output. Possible values: id, name. [optional] [default to 'name']

Return type

\Savvii\OpenproviderRest\Model\NameserverListNameserversResponse

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

updateNameserver()

updateNameserver($name, $body): \Savvii\OpenproviderRest\Model\NameserverNameserverBoolResponse

Update nameserver

Example

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


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


$apiInstance = new Savvii\OpenproviderRest\Api\NameserverServiceApi(
    // 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
);
$name = 'name_example'; // string | Nameserver name
$body = new \Savvii\OpenproviderRest\Model\NameserverNameserver(); // \Savvii\OpenproviderRest\Model\NameserverNameserver

try {
    $result = $apiInstance->updateNameserver($name, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling NameserverServiceApi->updateNameserver: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
name string Nameserver name
body \Savvii\OpenproviderRest\Model\NameserverNameserver

Return type

\Savvii\OpenproviderRest\Model\NameserverNameserverBoolResponse

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]