Skip to content

Latest commit

 

History

History
96 lines (74 loc) · 4.64 KB

ZoneRecordServiceApi.md

File metadata and controls

96 lines (74 loc) · 4.64 KB

Savvii\OpenproviderRest\ZoneRecordServiceApi

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

Method HTTP request Description
listZoneRecords() GET /v1beta/dns/zones/{name}/records List zone records

listZoneRecords()

listZoneRecords($name, $zone_id, $limit, $offset, $order_by_type, $order_by_name, $order_by_value, $order_by_ttl, $order_by_prio, $record_name_pattern, $value_pattern, $type, $prio, $ttl, $zone_provider): \Savvii\OpenproviderRest\Model\RecordListZoneRecordsResponse

List zone records

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\ZoneRecordServiceApi(
    // 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 | DNS record name
$zone_id = 56; // int | DNS zone ID.
$limit = 100; // int | How many records to retrieve (default: 100, max 500).
$offset = 56; // int | From which record to retrieve (default: 0).
$order_by_type = 'asc'; // string | Sorting type (asc/desc).
$order_by_name = 'asc'; // string | Sorting type (asc/desc).
$order_by_value = 'order_by_value_example'; // string | Sorting type (asc/desc).
$order_by_ttl = 'order_by_ttl_example'; // string | Sorting type (asc/desc).
$order_by_prio = 'order_by_prio_example'; // string | Sorting type (asc/desc).
$record_name_pattern = 'record_name_pattern_example'; // string | DNS record name pattern. Wildcard (*) can be used.
$value_pattern = 'value_pattern_example'; // string | DNS record value pattern. Wildcard (*) can be used.
$type = 'type_example'; // string | DNS record type.
$prio = 56; // int | DNS record priority.
$ttl = 56; // int | DNS record TTL.
$zone_provider = 'zone_provider_example'; // string | Name of the DNS provider. Set zone_provider=sectigo in case of only sectigo premium DNS zone records should be retrieved.

try {
    $result = $apiInstance->listZoneRecords($name, $zone_id, $limit, $offset, $order_by_type, $order_by_name, $order_by_value, $order_by_ttl, $order_by_prio, $record_name_pattern, $value_pattern, $type, $prio, $ttl, $zone_provider);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ZoneRecordServiceApi->listZoneRecords: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
name string DNS record name
zone_id int DNS zone ID. [optional]
limit int How many records to retrieve (default: 100, max 500). [optional] [default to 100]
offset int From which record to retrieve (default: 0). [optional]
order_by_type string Sorting type (asc/desc). [optional] [default to 'asc']
order_by_name string Sorting type (asc/desc). [optional] [default to 'asc']
order_by_value string Sorting type (asc/desc). [optional]
order_by_ttl string Sorting type (asc/desc). [optional]
order_by_prio string Sorting type (asc/desc). [optional]
record_name_pattern string DNS record name pattern. Wildcard (*) can be used. [optional]
value_pattern string DNS record value pattern. Wildcard (*) can be used. [optional]
type string DNS record type. [optional]
prio int DNS record priority. [optional]
ttl int DNS record TTL. [optional]
zone_provider string Name of the DNS provider. Set zone_provider=sectigo in case of only sectigo premium DNS zone records should be retrieved. [optional]

Return type

\Savvii\OpenproviderRest\Model\RecordListZoneRecordsResponse

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]