|
| 1 | +# Hostinger\DomainsAvailabilityApi |
| 2 | + |
| 3 | +All URIs are relative to https://developers.hostinger.com, except if the operation defines another base path. |
| 4 | + |
| 5 | +| Method | HTTP request | Description | |
| 6 | +| ------------- | ------------- | ------------- | |
| 7 | +| [**checkDomainAvailabilityV1()**](DomainsAvailabilityApi.md#checkDomainAvailabilityV1) | **POST** /api/domains/v1/availability | Check domain availability | |
| 8 | + |
| 9 | + |
| 10 | +## `checkDomainAvailabilityV1()` |
| 11 | + |
| 12 | +```php |
| 13 | +checkDomainAvailabilityV1($domainsV1AvailabilityAvailabilityRequest): \Hostinger\Model\DomainsV1AvailabilityAvailabilityResource[] |
| 14 | +``` |
| 15 | + |
| 16 | +Check domain availability |
| 17 | + |
| 18 | +This endpoint checks the availability of a domain name. Multiple TLDs can be checked at once. Endpoint has rate limit of 10 requests per minute. |
| 19 | + |
| 20 | +### Example |
| 21 | + |
| 22 | +```php |
| 23 | +<?php |
| 24 | +require_once(__DIR__ . '/vendor/autoload.php'); |
| 25 | + |
| 26 | + |
| 27 | +// Configure Bearer authorization: apiToken |
| 28 | +$config = Hostinger\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN'); |
| 29 | + |
| 30 | + |
| 31 | +$apiInstance = new Hostinger\Api\DomainsAvailabilityApi(config: $config); |
| 32 | +$domainsV1AvailabilityAvailabilityRequest = new \Hostinger\Model\DomainsV1AvailabilityAvailabilityRequest(); // \Hostinger\Model\DomainsV1AvailabilityAvailabilityRequest |
| 33 | + |
| 34 | +try { |
| 35 | + $result = $apiInstance->checkDomainAvailabilityV1($domainsV1AvailabilityAvailabilityRequest); |
| 36 | + print_r($result); |
| 37 | +} catch (Exception $e) { |
| 38 | + echo 'Exception when calling DomainsAvailabilityApi->checkDomainAvailabilityV1: ', $e->getMessage(), PHP_EOL; |
| 39 | +} |
| 40 | +``` |
| 41 | + |
| 42 | +### Parameters |
| 43 | + |
| 44 | +| Name | Type | Description | Notes | |
| 45 | +| ------------- | ------------- | ------------- | ------------- | |
| 46 | +| **domainsV1AvailabilityAvailabilityRequest** | [**\Hostinger\Model\DomainsV1AvailabilityAvailabilityRequest**](../Model/DomainsV1AvailabilityAvailabilityRequest.md)| | | |
| 47 | + |
| 48 | +### Return type |
| 49 | + |
| 50 | +[**\Hostinger\Model\DomainsV1AvailabilityAvailabilityResource[]**](../Model/DomainsV1AvailabilityAvailabilityResource.md) |
| 51 | + |
| 52 | +[[Back to top]](#) [[Back to API list]](../../README.md#endpoints) |
| 53 | +[[Back to Model list]](../../README.md#models) |
| 54 | +[[Back to README]](../../README.md) |
0 commit comments