|
| 1 | +# hostinger_api.DomainsAvailabilityApi |
| 2 | + |
| 3 | +All URIs are relative to *https://developers.hostinger.com* |
| 4 | + |
| 5 | +Method | HTTP request | Description |
| 6 | +------------- | ------------- | ------------- |
| 7 | +[**check_domain_availability_v1**](DomainsAvailabilityApi.md#check_domain_availability_v1) | **POST** /api/domains/v1/availability | Check domain availability |
| 8 | + |
| 9 | + |
| 10 | +# **check_domain_availability_v1** |
| 11 | +> List[DomainsV1AvailabilityAvailabilityResource] check_domain_availability_v1(domains_v1_availability_availability_request) |
| 12 | +
|
| 13 | +Check domain availability |
| 14 | + |
| 15 | +This endpoint checks the availability of a domain name. Multiple TLDs can be checked at once. |
| 16 | + |
| 17 | +Endpoint has rate limit of 10 requests per minute. |
| 18 | + |
| 19 | +### Example |
| 20 | + |
| 21 | +* Bearer Authentication (apiToken): |
| 22 | + |
| 23 | +```python |
| 24 | +import hostinger_api |
| 25 | +from hostinger_api.models.domains_v1_availability_availability_request import DomainsV1AvailabilityAvailabilityRequest |
| 26 | +from hostinger_api.models.domains_v1_availability_availability_resource import DomainsV1AvailabilityAvailabilityResource |
| 27 | +from hostinger_api.rest import ApiException |
| 28 | +from pprint import pprint |
| 29 | + |
| 30 | + |
| 31 | +# Configure Bearer authorization: apiToken |
| 32 | +configuration = hostinger_api.Configuration( |
| 33 | + access_token = os.environ["BEARER_TOKEN"] |
| 34 | +) |
| 35 | + |
| 36 | +# Enter a context with an instance of the API client |
| 37 | +with hostinger_api.ApiClient(configuration) as api_client: |
| 38 | + # Create an instance of the API class |
| 39 | + api_instance = hostinger_api.DomainsAvailabilityApi(api_client) |
| 40 | + domains_v1_availability_availability_request = hostinger_api.DomainsV1AvailabilityAvailabilityRequest() # DomainsV1AvailabilityAvailabilityRequest | |
| 41 | + |
| 42 | + try: |
| 43 | + # Check domain availability |
| 44 | + api_response = api_instance.check_domain_availability_v1(domains_v1_availability_availability_request) |
| 45 | + print("The response of DomainsAvailabilityApi->check_domain_availability_v1:\n") |
| 46 | + pprint(api_response) |
| 47 | + except Exception as e: |
| 48 | + print("Exception when calling DomainsAvailabilityApi->check_domain_availability_v1: %s\n" % e) |
| 49 | +``` |
| 50 | + |
| 51 | + |
| 52 | + |
| 53 | +### Parameters |
| 54 | + |
| 55 | + |
| 56 | +Name | Type | Description | Notes |
| 57 | +------------- | ------------- | ------------- | ------------- |
| 58 | + **domains_v1_availability_availability_request** | [**DomainsV1AvailabilityAvailabilityRequest**](DomainsV1AvailabilityAvailabilityRequest.md)| | |
| 59 | + |
| 60 | +### Return type |
| 61 | + |
| 62 | +[**List[DomainsV1AvailabilityAvailabilityResource]**](DomainsV1AvailabilityAvailabilityResource.md) |
| 63 | + |
| 64 | +### Authorization |
| 65 | + |
| 66 | +[apiToken](../README.md#apiToken) |
| 67 | + |
| 68 | +### HTTP request headers |
| 69 | + |
| 70 | + - **Content-Type**: application/json |
| 71 | + - **Accept**: application/json |
| 72 | + |
| 73 | +### HTTP response details |
| 74 | + |
| 75 | +| Status code | Description | Response headers | |
| 76 | +|-------------|-------------|------------------| |
| 77 | +**200** | Success response | - | |
| 78 | +**422** | Validation error response | - | |
| 79 | +**401** | Unauthenticated | - | |
| 80 | +**500** | Error response | - | |
| 81 | + |
| 82 | +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) |
| 83 | + |
0 commit comments