Skip to content

DomainsWHOISApi.md

Latest commit

 

History

History
242 lines (159 loc) · 7.03 KB

DomainsWHOISApi.md

File metadata and controls

242 lines (159 loc) · 7.03 KB

Hostinger\DomainsWHOISApi

All URIs are relative to https://developers.hostinger.com, except if the operation defines another base path.

Method HTTP request Description
createWHOISProfileV1() POST /api/domains/v1/whois Create WHOIS profile
deleteWHOISProfileV1() DELETE /api/domains/v1/whois/{whoisId} Delete WHOIS profile
getWHOISProfileListV1() GET /api/domains/v1/whois Get WHOIS profile list
getWHOISProfileUsageV1() GET /api/domains/v1/whois/{whoisId}/usage Get WHOIS profile usage
getWHOISProfileV1() GET /api/domains/v1/whois/{whoisId} Get WHOIS profile

createWHOISProfileV1()

createWHOISProfileV1($domainsV1WHOISStoreRequest): \Hostinger\Model\DomainsV1WHOISProfileResource

Create WHOIS profile

Create WHOIS contact profile. Use this endpoint to add new contact information for domain registration.

Example

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


// Configure Bearer authorization: apiToken
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Hostinger\Api\DomainsWHOISApi(config: $config);
$domainsV1WHOISStoreRequest = new \Hostinger\Model\DomainsV1WHOISStoreRequest(); // \Hostinger\Model\DomainsV1WHOISStoreRequest

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

Parameters

Name Type Description Notes
domainsV1WHOISStoreRequest \Hostinger\Model\DomainsV1WHOISStoreRequest

Return type

\Hostinger\Model\DomainsV1WHOISProfileResource

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

deleteWHOISProfileV1()

deleteWHOISProfileV1($whoisId): \Hostinger\Model\CommonSuccessEmptyResource

Delete WHOIS profile

Delete WHOIS contact profile. Use this endpoint to remove unused contact profiles from account.

Example

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


// Configure Bearer authorization: apiToken
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Hostinger\Api\DomainsWHOISApi(config: $config);
$whoisId = 564651; // int | WHOIS ID

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

Parameters

Name Type Description Notes
whoisId int WHOIS ID

Return type

\Hostinger\Model\CommonSuccessEmptyResource

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

getWHOISProfileListV1()

getWHOISProfileListV1($tld): \Hostinger\Model\DomainsV1WHOISProfileResource[]

Get WHOIS profile list

Retrieve WHOIS contact profiles. Use this endpoint to view available contact profiles for domain registration.

Example

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


// Configure Bearer authorization: apiToken
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Hostinger\Api\DomainsWHOISApi(config: $config);
$tld = com; // string | Filter by TLD (without leading dot)

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

Parameters

Name Type Description Notes
tld string Filter by TLD (without leading dot) [optional]

Return type

\Hostinger\Model\DomainsV1WHOISProfileResource[]

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

getWHOISProfileUsageV1()

getWHOISProfileUsageV1($whoisId): string[]

Get WHOIS profile usage

Retrieve domain list where provided WHOIS contact profile is used. Use this endpoint to view which domains use specific contact profiles.

Example

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


// Configure Bearer authorization: apiToken
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Hostinger\Api\DomainsWHOISApi(config: $config);
$whoisId = 564651; // int | WHOIS ID

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

Parameters

Name Type Description Notes
whoisId int WHOIS ID

Return type

string[]

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

getWHOISProfileV1()

getWHOISProfileV1($whoisId): \Hostinger\Model\DomainsV1WHOISProfileResource

Get WHOIS profile

Retrieve a WHOIS contact profile. Use this endpoint to view domain registration contact information.

Example

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


// Configure Bearer authorization: apiToken
$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Hostinger\Api\DomainsWHOISApi(config: $config);
$whoisId = 564651; // int | WHOIS ID

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

Parameters

Name Type Description Notes
whoisId int WHOIS ID

Return type

\Hostinger\Model\DomainsV1WHOISProfileResource

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